diff --git a/examples/1ptracer/.doc_config b/examples/1ptracer/.doc_config index 1e19fd5213c7856fb57cd73a6cc824fde2728d2d..04e6e3bc1311158571514894dceffa6976ce18b1 100644 --- a/examples/1ptracer/.doc_config +++ b/examples/1ptracer/.doc_config @@ -1,32 +1,32 @@ { "README.md" : [ - "doc/intro.md" + "doc/_intro.md" ], - "doc/1pmodel.md" : [ - "doc/1pintro.md", + "doc/1p.md" : [ + "doc/1p_intro.md", "properties_1p.hh", "problem_1p.hh", "spatialparams_1p.hh" ], - "doc/tracermodel.md" : [ - "doc/tracerintro.md", + "doc/tracer.md" : [ + "doc/tracer_intro.md", "properties_tracer.hh", "problem_tracer.hh", "spatialparams_tracer.hh" ], "doc/main.md" : [ - "doc/mainintro.md", + "doc/main_intro.md", "main.cc" ], "navigation" : { "mainpage" : "README.md", "subpages" : [ - "doc/1pmodel.md", - "doc/tracermodel.md", + "doc/1p.md", + "doc/tracer.md", "doc/main.md" ], "subtitles" : [ diff --git a/examples/1ptracer/README.md b/examples/1ptracer/README.md index 6564359644765b27426d259eef98ed999a7db695..516fc37705251a6bc871116fc08e7eec2dd96933 100644 --- a/examples/1ptracer/README.md +++ b/examples/1ptracer/README.md @@ -117,13 +117,13 @@ 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 documentation](doc/1pmodel.md) | +| [:arrow_right: Click to continue with part 1 of the documentation](doc/1p.md) | |---:| ## Part 2: Tracer transport simulation setup -| [:arrow_right: Click to continue with part 2 of the documentation](doc/tracermodel.md) | +| [:arrow_right: Click to continue with part 2 of the documentation](doc/tracer.md) | |---:| diff --git a/examples/1ptracer/doc/1pmodel.md b/examples/1ptracer/doc/1p.md similarity index 99% rename from examples/1ptracer/doc/1pmodel.md rename to examples/1ptracer/doc/1p.md index 97d9f7b2e43b7599497d69ccc3de4b5eb25b1c25..a550664425f15446d2b9f961a37e385be95548ea 100644 --- a/examples/1ptracer/doc/1pmodel.md +++ b/examples/1ptracer/doc/1p.md @@ -1,7 +1,7 @@ <!-- 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) | +| [:arrow_left: Back to the main documentation](../README.md) | [:arrow_right: Continue with part 2](tracer.md) | |---|---:| # Part 1: Implementation of the single-phase flow simulation setup @@ -461,6 +461,6 @@ private: </details> -| [:arrow_left: Back to the main documentation](../README.md) | [:arrow_right: Continue with part 2](tracermodel.md) | +| [:arrow_left: Back to the main documentation](../README.md) | [:arrow_right: Continue with part 2](tracer.md) | |---|---:| diff --git a/examples/1ptracer/doc/1pintro.md b/examples/1ptracer/doc/1p_intro.md similarity index 100% rename from examples/1ptracer/doc/1pintro.md rename to examples/1ptracer/doc/1p_intro.md diff --git a/examples/1ptracer/doc/intro.md b/examples/1ptracer/doc/_intro.md similarity index 100% rename from examples/1ptracer/doc/intro.md rename to examples/1ptracer/doc/_intro.md diff --git a/examples/1ptracer/doc/main.md b/examples/1ptracer/doc/main.md index f2005ef8a590e4ad9d19590257741b193d1dd41e..b7e2d43ff9f93c697563adcc0cd98796ebd8fbc5 100644 --- a/examples/1ptracer/doc/main.md +++ b/examples/1ptracer/doc/main.md @@ -1,7 +1,7 @@ <!-- 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) | [:arrow_left: Go back to part 2](tracer.md) | |---|---:| # Part 3: Main program flow @@ -425,6 +425,6 @@ 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_left: Go back to part 2](tracer.md) | |---|---:| diff --git a/examples/1ptracer/doc/mainintro.md b/examples/1ptracer/doc/main_intro.md similarity index 100% rename from examples/1ptracer/doc/mainintro.md rename to examples/1ptracer/doc/main_intro.md diff --git a/examples/1ptracer/doc/tracermodel.md b/examples/1ptracer/doc/tracer.md similarity index 99% rename from examples/1ptracer/doc/tracermodel.md rename to examples/1ptracer/doc/tracer.md index e4076365671e0791c23b7c845c7927ac43f82102..7dee8dd18923f13bd50f03995816483b50d700a1 100644 --- a/examples/1ptracer/doc/tracermodel.md +++ b/examples/1ptracer/doc/tracer.md @@ -1,7 +1,7 @@ <!-- 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 1](1pmodel.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](1p.md) | [:arrow_right: Continue with part 3](main.md) | |---|---|---:| # Part 2: Implementation of the tracer transport simulation setup @@ -521,6 +521,6 @@ private: </details> -| [: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) | +| [:arrow_left: Back to the main documentation](../README.md) | [:arrow_left: Go back to part 1](1p.md) | [:arrow_right: Continue with part 3](main.md) | |---|---|---:| diff --git a/examples/1ptracer/doc/tracerintro.md b/examples/1ptracer/doc/tracer_intro.md similarity index 100% rename from examples/1ptracer/doc/tracerintro.md rename to examples/1ptracer/doc/tracer_intro.md