diff --git a/examples/1ptracer/README.md b/examples/1ptracer/README.md index 68e153ff58d6792c1b84c5bb3d9710a591dca2dd..800d566544772bd7cd780d6f8cc1a54bcee4a4e6 100644 --- a/examples/1ptracer/README.md +++ b/examples/1ptracer/README.md @@ -1,3 +1,5 @@ +<!-- Important: This file has been automatically generated by generate_example_docs.py. Do not edit this file directly! --> + # One-phase flow with random permeability distribution and a tracer model ## Problem set-up diff --git a/examples/2pinfiltration/README.md b/examples/2pinfiltration/README.md index 32fe01bdd88dedca5bfe1769ff5d197d7029a25f..acc2eb9c57b4835e4ef2f5ca0edda77d1fcee969 100644 --- a/examples/2pinfiltration/README.md +++ b/examples/2pinfiltration/README.md @@ -1,3 +1,5 @@ +<!-- Important: This file has been automatically generated by generate_example_docs.py. Do not edit this file directly! --> + This tutorial is similar to tests/porousmediumflow/2p/adaptive and restricted to the cell-centered finite volume TPFA discretization scheme. You need [ALUGrid][0] in order to compile and run it. diff --git a/examples/freeflowchannel/README.md b/examples/freeflowchannel/README.md index c06fd91176746329c21569312356b9ad5c42a2ae..6ee3225810e66a4a2590d49e84737f5ebe1f6450 100644 --- a/examples/freeflowchannel/README.md +++ b/examples/freeflowchannel/README.md @@ -1,3 +1,5 @@ +<!-- Important: This file has been automatically generated by generate_example_docs.py. Do not edit this file directly! --> + This example is based on dumux/test/freeflow/navierstokes/channel/2d. # Freeflow through a channel diff --git a/examples/generate_example_docs.py b/examples/generate_example_docs.py index c20f706be3f5b0d1b82ab548dccfb79ec273f465..d167fe351d838fd11d947c4ba5a8913e66158adb 100755 --- a/examples/generate_example_docs.py +++ b/examples/generate_example_docs.py @@ -18,6 +18,8 @@ def convertToMarkdownAndMerge(dir, config): os.makedirs(os.path.dirname(targetPath), exist_ok=True) with open(targetPath, "w") as targetFile: + thisScript = os.path.basename(__file__) + targetFile.write("<!-- Important: This file has been automatically generated by {}. Do not edit this file directly! -->\n\n".format(thisScript)) for source in sources: fileExtension = os.path.splitext(source)[1] if fileExtension == ".md": diff --git a/examples/shallowwaterfriction/README.md b/examples/shallowwaterfriction/README.md index c59eded330c24598808e562bbe5410e2c04cc264..45c815cc64d07f68ce9061ddefc54dc4f990333a 100644 --- a/examples/shallowwaterfriction/README.md +++ b/examples/shallowwaterfriction/README.md @@ -1,3 +1,5 @@ +<!-- Important: This file has been automatically generated by generate_example_docs.py. Do not edit this file directly! --> + # Shallow water flow with bottom friction This example shows how the shallow water flow model can be applied to simulate steady subcritical flow including