[docs] Switch to markdown mainfile

Supported for doxygen 1.8.3 and later (released 2012)
Cantera · Jul 8, 2023 · 2c7b471 · 2c7b471
1 parent 57dafca
commit 2c7b471
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 8 deletions.
diff --git a/doc/doxygen/Cantera.txt b/doc/doxygen/Cantera.txt
diff --git a/doc/doxygen/Doxyfile b/doc/doxygen/Doxyfile
@@ -866,7 +866,8 @@ INPUT                  = src/base \
                          src/transport \
                          src/zeroD \
                          include \
-                         doc/doxygen
+                         doc/doxygen \
+                         doc/doxygen/mainpage.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
@@ -1027,7 +1028,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 = mainpage.md
 
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing

diff --git a/doc/doxygen/mainpage.md b/doc/doxygen/mainpage.md
@@ -0,0 +1,6 @@
+# %Cantera C++ Reference
+
+Use the menu at the top to view detailed documentation of the code.
+
+* Overview of [Cantera Modules](modules.html)
+* Index of [Cantera Classes](classes.html)