summaryrefslogtreecommitdiffstats
path: root/Doxygen
diff options
context:
space:
mode:
Diffstat (limited to 'Doxygen')
-rw-r--r--Doxygen/doxyfig4
-rw-r--r--Doxygen/doxyrun.sh10
2 files changed, 11 insertions, 3 deletions
diff --git a/Doxygen/doxyfig b/Doxygen/doxyfig
index 6274cfa..491cc58 100644
--- a/Doxygen/doxyfig
+++ b/Doxygen/doxyfig
@@ -829,7 +829,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
-INPUT = "../Src/"
+INPUT = "../Src/" "index.md"
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1026,7 +1026,7 @@ FILTER_SOURCE_PATTERNS =
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.
-USE_MDFILE_AS_MAINPAGE =
+USE_MDFILE_AS_MAINPAGE = index.md
#---------------------------------------------------------------------------
# Configuration options related to source browsing
diff --git a/Doxygen/doxyrun.sh b/Doxygen/doxyrun.sh
index b3dbc61..a8ae488 100644
--- a/Doxygen/doxyrun.sh
+++ b/Doxygen/doxyrun.sh
@@ -1 +1,9 @@
-sudo doxygen doxyfig
+# Copy repository readme here to be used as a cover page
+tail ../readme.md -n +2 > index.md
+
+# Run doxygen
+doxygen doxyfig
+
+# Cleanup index.md
+rm -f index.md
+