From 6544942d20a900f799caa833febb906661dbd967 Mon Sep 17 00:00:00 2001
From: Timo Koch <timo.koch@iws.uni-stuttgart.de>
Date: Wed, 1 Apr 2020 18:11:25 +0200
Subject: [PATCH] [examples] Add horizontal rules after file includes
---
examples/freeflowchannel/README.md | 5 +++++
examples/generate_example_docs.py | 2 +-
examples/shallowwaterfriction/README.md | 4 ++++
3 files changed, 10 insertions(+), 1 deletion(-)
diff --git a/examples/freeflowchannel/README.md b/examples/freeflowchannel/README.md
index 0ab86fa2a4..71899e09ca 100644
--- a/examples/freeflowchannel/README.md
+++ b/examples/freeflowchannel/README.md
@@ -106,6 +106,7 @@ struct EnableGridGeometryCache<TypeTag, TTag::ChannelExample> { static constexpr
```
+----------
## The file `problem.hh`
@@ -315,6 +316,7 @@ Finally, private variables are declared:
</details>
+----------
## The file `main.cc`
@@ -603,3 +605,6 @@ catch (...)
```
</details>
+
+
+----------
diff --git a/examples/generate_example_docs.py b/examples/generate_example_docs.py
index dc97ba7da5..39e8f3653f 100755
--- a/examples/generate_example_docs.py
+++ b/examples/generate_example_docs.py
@@ -28,7 +28,7 @@ def convertToMarkdownAndMerge(dir, config):
elif fileExtension == ".hh" or fileExtension == ".cc":
with open(os.path.join(dir, source), "r") as cppCode:
sourceRelPath = os.path.relpath(os.path.abspath(os.path.join(dir, source)), os.path.split(os.path.abspath(targetPath))[0])
- targetFile.write("\n\n" + transformCode(cppCode.read(), cppRules(), sourceRelPath) + "\n")
+ targetFile.write("\n\n" + transformCode(cppCode.read(), cppRules(), sourceRelPath) + "\n----------\n")
else:
raise IOError("Unsupported or unknown file extension *{}".format(fileExtension))
diff --git a/examples/shallowwaterfriction/README.md b/examples/shallowwaterfriction/README.md
index e71e3b5460..82512d4a23 100644
--- a/examples/shallowwaterfriction/README.md
+++ b/examples/shallowwaterfriction/README.md
@@ -180,6 +180,7 @@ struct EnableGridGeometryCache<TypeTag, TTag::RoughChannel>
```
+----------
## The file `spatialparams.hh`
@@ -322,6 +323,7 @@ end of namespace Dumux.
```
+----------
## The file `problem.hh`
@@ -688,6 +690,7 @@ eps is used as a small value for the definition of the boundry conditions
```
+----------
## The file `main.cc`
@@ -1020,3 +1023,4 @@ catch (...)
```
+----------
--
GitLab