From 4a44821d85cf175b52046d67077fff414a47257a Mon Sep 17 00:00:00 2001 From: Timo Koch <timo.koch@iws.uni-stuttgart.de> Date: Thu, 2 Apr 2020 13:48:19 +0200 Subject: [PATCH] [examples][tracer] Add inter-document links --- examples/1ptracer/README.md | 15 ++++++++++++--- examples/1ptracer/doc/1pintro.md | 5 ++++- examples/1ptracer/doc/1pmodel.md | 5 ++++- examples/1ptracer/doc/intro.md | 15 ++++++++++++--- examples/1ptracer/doc/main.md | 5 ++++- examples/1ptracer/doc/tracerintro.md | 5 ++++- examples/1ptracer/doc/tracermodel.md | 5 ++++- examples/1ptracer/main.cc | 6 ++++-- 8 files changed, 48 insertions(+), 13 deletions(-) diff --git a/examples/1ptracer/README.md b/examples/1ptracer/README.md index 86700edac2..010b7710d3 100644 --- a/examples/1ptracer/README.md +++ b/examples/1ptracer/README.md @@ -110,8 +110,17 @@ In the documentations behind the links provided in the following, you will find 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`). -## [Implementation of the single-phase flow simulation setup](doc/1pmodel.md) +## Part 1: Single-phase flow simulation setup -## [Implementation of the tracer transport simulation setup](doc/tracermodel.md) +| [:arrow_right: Click to continue with part 1 of the code documentation](doc/1pmodel.md) | +|---:| -## [Main program flow](doc/main.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) | +|---:| diff --git a/examples/1ptracer/doc/1pintro.md b/examples/1ptracer/doc/1pintro.md index 61a8f95eed..707a370eaf 100644 --- a/examples/1ptracer/doc/1pintro.md +++ b/examples/1ptracer/doc/1pintro.md @@ -1,4 +1,7 @@ -# Implementation of the single-phase flow simulation setup +| [: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`, `problem_1p.hh` and `spatialparams_1p.hh`. In the first of these files, a new diff --git a/examples/1ptracer/doc/1pmodel.md b/examples/1ptracer/doc/1pmodel.md index 48b55e6dac..a7ac8a5f30 100644 --- a/examples/1ptracer/doc/1pmodel.md +++ b/examples/1ptracer/doc/1pmodel.md @@ -1,6 +1,9 @@ <!-- Important: This file has been automatically generated by generate_example_docs.py. Do not edit this file directly! --> -# Implementation of the single-phase flow simulation setup +| [: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`, `problem_1p.hh` and `spatialparams_1p.hh`. In the first of these files, a new diff --git a/examples/1ptracer/doc/intro.md b/examples/1ptracer/doc/intro.md index cf08a89f0f..9eaf89136c 100644 --- a/examples/1ptracer/doc/intro.md +++ b/examples/1ptracer/doc/intro.md @@ -108,8 +108,17 @@ In the documentations behind the links provided in the following, you will find 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`). -## [Implementation of the single-phase flow simulation setup](doc/1pmodel.md) +## Part 1: Single-phase flow simulation setup -## [Implementation of the tracer transport simulation setup](doc/tracermodel.md) +| [:arrow_right: Click to continue with part 1 of the code documentation](doc/1pmodel.md) | +|---:| -## [Main program flow](doc/main.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) | +|---:| diff --git a/examples/1ptracer/doc/main.md b/examples/1ptracer/doc/main.md index 89137a3427..510acc6ec0 100644 --- a/examples/1ptracer/doc/main.md +++ b/examples/1ptracer/doc/main.md @@ -2,7 +2,10 @@ -# Main program flow (`main.cc`) +| [:arrow_left: Back to the main documentation](../README.md) | +|---:| + +# Part 3: Main program flow (`main.cc`) [[_TOC_]] diff --git a/examples/1ptracer/doc/tracerintro.md b/examples/1ptracer/doc/tracerintro.md index 9b64df8053..e894e45805 100644 --- a/examples/1ptracer/doc/tracerintro.md +++ b/examples/1ptracer/doc/tracerintro.md @@ -1,4 +1,7 @@ -# Implementation of the tracer transport simulation setup +| [: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`, `problem_tracer.hh` and `spatialparams_tracer.hh`. In the first of these files, a new diff --git a/examples/1ptracer/doc/tracermodel.md b/examples/1ptracer/doc/tracermodel.md index 3a6f3ac2c0..00334457fe 100644 --- a/examples/1ptracer/doc/tracermodel.md +++ b/examples/1ptracer/doc/tracermodel.md @@ -1,6 +1,9 @@ <!-- Important: This file has been automatically generated by generate_example_docs.py. Do not edit this file directly! --> -# Implementation of the tracer transport simulation setup +| [: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`, `problem_tracer.hh` and `spatialparams_tracer.hh`. In the first of these files, a new diff --git a/examples/1ptracer/main.cc b/examples/1ptracer/main.cc index b1c6b23f88..5425a700fe 100644 --- a/examples/1ptracer/main.cc +++ b/examples/1ptracer/main.cc @@ -16,8 +16,10 @@ * You should have received a copy of the GNU General Public License * * along with this program. If not, see <http://www.gnu.org/licenses/>. * *****************************************************************************/ - -// # Main program flow (`main.cc`) +// | [:arrow_left: Back to the main documentation](../README.md) | +// |---:| +// +// # Part 3: Main program flow (`main.cc`) // // [[_TOC_]] // -- GitLab