diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index 1ccb31f..210445a 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -6,6 +6,7 @@ on: paths: - 'include/**' - 'Doxyfile' + - 'docs/doxygen-theme/**' - '.github/workflows/doxygen.yml' - 'README.md' @@ -35,6 +36,17 @@ jobs: sudo apt-get update sudo apt-get install -y graphviz + - name: Download Doxygen Awesome theme + run: | + THEME_DIR=docs/doxygen-theme + DOXYGEN_AWESOME_URL=https://raw.githubusercontent.com/jothepro/doxygen-awesome-css/v2.4.1 + wget -q -O $THEME_DIR/doxygen-awesome.css $DOXYGEN_AWESOME_URL/doxygen-awesome.css + wget -q -O $THEME_DIR/doxygen-awesome-darkmode-toggle.js $DOXYGEN_AWESOME_URL/doxygen-awesome-darkmode-toggle.js + wget -q -O $THEME_DIR/doxygen-awesome-fragment-copy-button.js $DOXYGEN_AWESOME_URL/doxygen-awesome-fragment-copy-button.js + wget -q -O $THEME_DIR/doxygen-awesome-paragraph-link.js $DOXYGEN_AWESOME_URL/doxygen-awesome-paragraph-link.js + wget -q -O $THEME_DIR/doxygen-awesome-interactive-toc.js $DOXYGEN_AWESOME_URL/doxygen-awesome-interactive-toc.js + wget -q -O $THEME_DIR/doxygen-awesome-tabs.js $DOXYGEN_AWESOME_URL/doxygen-awesome-tabs.js + - name: Generate documentation run: | doxygen Doxyfile diff --git a/Doxyfile b/Doxyfile index f915660..379029a 100644 --- a/Doxyfile +++ b/Doxyfile @@ -44,6 +44,15 @@ HTML_OUTPUT = . GENERATE_LATEX = NO GENERATE_XML = NO +# Doxygen Awesome theme integration +HTML_HEADER = docs/doxygen-theme/header.html +HTML_EXTRA_STYLESHEET = docs/doxygen-theme/doxygen-awesome.css +HTML_EXTRA_FILES = docs/doxygen-theme/doxygen-awesome-darkmode-toggle.js \ + docs/doxygen-theme/doxygen-awesome-fragment-copy-button.js \ + docs/doxygen-theme/doxygen-awesome-paragraph-link.js \ + docs/doxygen-theme/doxygen-awesome-interactive-toc.js \ + docs/doxygen-theme/doxygen-awesome-tabs.js + HTML_COLORSTYLE = LIGHT HTML_COPY_CLIPBOARD = NO PAGE_OUTLINE_PANEL = NO diff --git a/docs/doxygen-theme/header.html b/docs/doxygen-theme/header.html new file mode 100644 index 0000000..8e5601c --- /dev/null +++ b/docs/doxygen-theme/header.html @@ -0,0 +1,89 @@ + + + + + + + + +$projectname: $title +$title + + + + + + + + + + + + +$treeview +$search +$mathjax +$darkmode + +$extrastylesheet + + + + + + + + + + +
+ + +
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
$projectname $projectnumber +
+
$projectbrief
+
+
$projectbrief
+
$searchbox
$searchbox
+
+ +