From 1107d7af44703371bc4630314470084cda43c35c Mon Sep 17 00:00:00 2001 From: Ingmar Schoegl Date: Mon, 17 Jul 2023 17:32:32 -0600 Subject: [PATCH] [docs] Switch doxygen theme --- .gitmodules | 3 +++ doc/doxygen/Doxyfile | 2 +- doc/doxygen/mainpage.md | 4 ++-- ext/doxygen-awesome-css | 1 + 4 files changed, 7 insertions(+), 3 deletions(-) create mode 160000 ext/doxygen-awesome-css diff --git a/.gitmodules b/.gitmodules index 1ae621077..8302fbd72 100644 --- a/.gitmodules +++ b/.gitmodules @@ -16,3 +16,6 @@ [submodule "ext/HighFive"] path = ext/HighFive url = https://github.com/BlueBrain/HighFive.git +[submodule "ext/doxygen-awesome-css"] + path = ext/doxygen-awesome-css + url = https://github.com/jothepro/doxygen-awesome-css.git diff --git a/doc/doxygen/Doxyfile b/doc/doxygen/Doxyfile index e185d9649..f8f4c4616 100644 --- a/doc/doxygen/Doxyfile +++ b/doc/doxygen/Doxyfile @@ -1212,7 +1212,7 @@ HTML_STYLESHEET = # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = +HTML_EXTRA_STYLESHEET = ext/doxygen-awesome-css/doxygen-awesome.css # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note diff --git a/doc/doxygen/mainpage.md b/doc/doxygen/mainpage.md index a51cb0ac0..1b8dce9db 100644 --- a/doc/doxygen/mainpage.md +++ b/doc/doxygen/mainpage.md @@ -3,8 +3,8 @@ > **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: +Use sidebar or menu at the top to view detailed documentation of the code, or +use the following shortcuts: * Overview of [**Cantera C++ Modules**](modules.html) * Index of [**Cantera C++ Classes**](classes.html) diff --git a/ext/doxygen-awesome-css b/ext/doxygen-awesome-css new file mode 160000 index 000000000..df83fbf22 --- /dev/null +++ b/ext/doxygen-awesome-css @@ -0,0 +1 @@ +Subproject commit df83fbf22cfff76b875c13d324baf584c74e96d0