From c4226cfeccf166dc7655e23b96d9c5d03d05c072 Mon Sep 17 00:00:00 2001
From: Timo Koch <timo.koch@iws.uni-stuttgart.de>
Date: Tue, 31 Mar 2020 09:28:49 +0200
Subject: [PATCH] [examples] Add statement at the beginning of autogenerated
files
---
examples/1ptracer/README.md | 2 ++
examples/2pinfiltration/README.md | 2 ++
examples/freeflowchannel/README.md | 2 ++
examples/generate_example_docs.py | 2 ++
examples/shallowwaterfriction/README.md | 2 ++
5 files changed, 10 insertions(+)
diff --git a/examples/1ptracer/README.md b/examples/1ptracer/README.md
index 68e153ff58..800d566544 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 32fe01bdd8..acc2eb9c57 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 c06fd91176..6ee3225810 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 c20f706be3..d167fe351d 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 c59eded330..45c815cc64 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
--
GitLab