Commit 6454b7d5 authored by Timo Koch's avatar Timo Koch
Browse files

[examples][tracer] Autogenerate navigation

parent 8714bd5d
......@@ -19,5 +19,19 @@
"doc/main.md" : [
"main.cc"
]
],
"navigation" : {
"mainpage" : "README.md",
"subpages" : [
"doc/1pmodel.md",
"doc/tracermodel.md",
"doc/main.md"
],
"subtitles" : [
"Single-phase flow simulation setup",
"Tracer transport simulation setup",
"Main program flow"
]
}
}
......@@ -112,15 +112,17 @@ simulations are solved sequentially in the main file (`main.cc`).
## Part 1: Single-phase flow simulation setup
| [:arrow_right: Click to continue with part 1 of the code documentation](doc/1pmodel.md) |
| [:arrow_right: Click to continue with part 1 of the documentation](doc/1pmodel.md) |
|---:|
## Part 2: Tracer transport simulation setup
| [:arrow_right: Click to continue with part 2 of the code documentation](doc/tracermodel.md) |
| [:arrow_right: Click to continue with part 2 of the documentation](doc/tracermodel.md) |
|---:|
## Part 3: Main program flow
| [:arrow_right: Click to continue with part 3 of the code documentation](doc/main.md) |
|---:|
| [:arrow_right: Click to continue with part 3 of the documentation](doc/main.md) |
|---:|
\ No newline at end of file
| [:arrow_left: Back to the main documentation](../README.md) | [:arrow_right: Continue with part 2](tracermodel.md) |
|---|---:|
# Part 1: Implementation of the single-phase flow simulation setup
The single-phase flow setup is implemented in the files `properties_1p.hh`,
......
<!-- Important: This file has been automatically generated by generate_example_docs.py. Do not edit this file directly! -->
| [:arrow_left: Back to the main documentation](../README.md) | [:arrow_right: Continue with part 2](tracermodel.md) |
|---|---:|
......@@ -439,3 +440,7 @@ private:
</details>
| [:arrow_left: Back to the main documentation](../README.md) | [:arrow_right: Continue with part 2](tracermodel.md) |
|---|---:|
......@@ -107,18 +107,3 @@ are implemented in a `SpatialParams` class.
In the documentations behind the links provided in the following, you will find how the above-
mentioned settings and classes are realized in this example. Finally, it is discussed how the two
simulations are solved sequentially in the main file (`main.cc`).
## Part 1: Single-phase flow simulation setup
| [:arrow_right: Click to continue with part 1 of the code documentation](doc/1pmodel.md) |
|---:|
## Part 2: Tracer transport simulation setup
| [:arrow_right: Click to continue with part 2 of the code documentation](doc/tracermodel.md) |
|---:|
## Part 3: Main program flow
| [:arrow_right: Click to continue with part 3 of the code documentation](doc/main.md) |
|---:|
<!-- Important: This file has been automatically generated by generate_example_docs.py. Do not edit this file directly! -->
| [:arrow_left: Back to the main documentation](../README.md) | [:arrow_left: Go back to part 2](tracermodel.md) |
|---|---:|
| [:arrow_left: Back to the main documentation](../README.md) |
|---:|
# Part 3: Main program flow (`main.cc`)
......@@ -411,3 +412,7 @@ catch (...)
</details>
| [:arrow_left: Back to the main documentation](../README.md) | [:arrow_left: Go back to part 2](tracermodel.md) |
|---|---:|
| [:arrow_left: Back to the main documentation](../README.md) | [:arrow_right: Continue with part 3](main.md) |
|---|---:|
# Part 2: Implementation of the tracer transport simulation setup
The tracer transport setup is implemented in the files `properties_tracer.hh`,
......
<!-- Important: This file has been automatically generated by generate_example_docs.py. Do not edit this file directly! -->
| [:arrow_left: Back to the main documentation](../README.md) | [:arrow_right: Continue with part 3](main.md) |
|---|---:|
| [:arrow_left: Back to the main documentation](../README.md) | [:arrow_left: Go back to part 1](1pmodel.md) | [:arrow_right: Continue with part 3](main.md) |
|---|---|---:|
# Part 2: Implementation of the tracer transport simulation setup
......@@ -498,3 +499,7 @@ private:
```
| [:arrow_left: Back to the main documentation](../README.md) | [:arrow_left: Go back to part 1](1pmodel.md) | [:arrow_right: Continue with part 3](main.md) |
|---|---|---:|
......@@ -16,9 +16,6 @@
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
// | [:arrow_left: Back to the main documentation](../README.md) |
// |---:|
//
// # Part 3: Main program flow (`main.cc`)
//
// [[_TOC_]]
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment