[docs] Add doxygen treeview

Cantera · Jul 17, 2023 · da574fd · da574fd
1 parent 451af04
commit da574fd
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 7 deletions.
diff --git a/doc/doxygen/Doxyfile b/doc/doxygen/Doxyfile
@@ -51,7 +51,7 @@ PROJECT_BRIEF          =
 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
 # the logo to the output directory.
 
-PROJECT_LOGO           =
+PROJECT_LOGO           = doc/sphinx/_static/images/cantera-icon.png
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is
@@ -866,8 +866,7 @@ INPUT                  = src/base \
                          src/transport \
                          src/zeroD \
                          include \
-                         doc/doxygen \
-                         doc/doxygen/mainpage.md
+                         doc/doxygen
 
 # 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
@@ -899,6 +898,7 @@ INPUT_ENCODING         = UTF-8
 FILE_PATTERNS          = *.h \
                          *.cpp \
                          *.txt \
+                         *.md \
                          *.dox
 
 # The RECURSIVE tag can be used to specify whether or not subdirectories should
@@ -1511,7 +1511,7 @@ DISABLE_INDEX          = NO
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-GENERATE_TREEVIEW      = NO
+GENERATE_TREEVIEW      = YES
 
 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
 # doxygen will group on one line in the generated HTML documentation.

diff --git a/doc/doxygen/mainpage.md b/doc/doxygen/mainpage.md
@@ -1,10 +1,13 @@
 # %Cantera C++ Reference
 
+> **Note:** This is the **%Cantera C++ API** documentation; for general
+> information on %Cantera, refer to [**Cantera's main website**](https://cantera.org).
+
 Use the menu at the top to view detailed documentation of the code, or use the
 following shortcuts:
 
-* Overview of [**Cantera Modules**](modules.html)
-* Index of [**Cantera Classes**](classes.html)
+* Overview of [**Cantera C++ Modules**](modules.html)
+* Index of [**Cantera C++ Classes**](classes.html)
 
 A topical overview is provided as follows:
 

diff --git a/doc/sphinx/_static/images/cantera-icon.png b/doc/sphinx/_static/images/cantera-icon.png
diff --git a/include/cantera/base/ctexceptions.h b/include/cantera/base/ctexceptions.h
@@ -19,7 +19,7 @@ namespace Cantera
 {
 
 /**
- * @defgroup debugGroup Errors & Diagnostics
+ * @defgroup debugGroup Errors and Diagnostics
 */
 
 /*!