Add a main page

otherwise the body is empty when you click on API in the sidebar
ufs-community · Jan 24, 2025 · 5fd7d0f · 5fd7d0f
1 parent e815ad6
commit 5fd7d0f
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 1 deletion.
diff --git a/docs/Doxyfile b/docs/Doxyfile
@@ -4,12 +4,14 @@ PROJECT_BRIEF =
 
 OPTIMIZE_FOR_FORTRAN = YES
 
-INPUT = ../src/core \
+INPUT = doxygen/index.md \
+        ../src/core \
         ../src/process/drydep \
         ../src/process/dust \
         ../src/process/plumerise \
         ../src/process/seasalt \
         ../src/api
+USE_MDFILE_AS_MAINPAGE = index.md
 FILE_PATTERNS = *.F90
 RECURSIVE = YES
 

diff --git a/docs/doxygen/.gitignore b/docs/doxygen/.gitignore
@@ -1,2 +1,3 @@
 *
 !.gitignore
+!index.md
diff --git a/docs/doxygen/index.md b/docs/doxygen/index.md
@@ -0,0 +1,3 @@
+CATChem API documentation generated by [Doxygen](https://www.doxygen.nl/) from source code comments,
+embedded in Sphinx with the help of [Doxysphinx](https://boschglobal.github.io/doxysphinx/).
+Use the sidebar and page links to navigate.