From 19aa837d68ae46e09bcbc4c9e577c9951d8ab49d Mon Sep 17 00:00:00 2001 From: Nedko Arnaudov Date: Sun, 27 Aug 2023 19:00:42 +0300 Subject: [PATCH] Use doxygen-awesome-css theme for docs --- .gitmodules | 3 ++ doc/doxygen-awesome-css | 1 + doc/doxygen-header.html | 78 +++++++++++++++++++++++++++++++++++++++++ doxyfile.in | 15 +++++--- 4 files changed, 93 insertions(+), 4 deletions(-) create mode 160000 doc/doxygen-awesome-css create mode 100644 doc/doxygen-header.html diff --git a/.gitmodules b/.gitmodules index ab496093..7ed7f17e 100644 --- a/.gitmodules +++ b/.gitmodules @@ -4,3 +4,6 @@ [submodule "jack-tools"] path = tools url = ../jack-tools +[submodule "doc/doxygen-awesome-css"] + path = doc/doxygen-awesome-css + url = https://github.com/jothepro/doxygen-awesome-css.git diff --git a/doc/doxygen-awesome-css b/doc/doxygen-awesome-css new file mode 160000 index 00000000..00a52f6c --- /dev/null +++ b/doc/doxygen-awesome-css @@ -0,0 +1 @@ +Subproject commit 00a52f6c74065ffbd836cbd791ddfe8edf2836b8 diff --git a/doc/doxygen-header.html b/doc/doxygen-header.html new file mode 100644 index 00000000..c25702fb --- /dev/null +++ b/doc/doxygen-header.html @@ -0,0 +1,78 @@ + + + + + + + + +$projectname: $title +$title + + + + + + + + +$treeview +$search +$mathjax +$darkmode + +$extrastylesheet + + + + + + +
+ + + +
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
$projectname $projectnumber +
+
$projectbrief
+ 		+
$projectbrief
+ 		$searchbox
$searchbox
+
+ + diff --git a/doxyfile.in b/doxyfile.in index 2335adab..42757104 100644 --- a/doxyfile.in +++ b/doxyfile.in @@ -25,7 +25,7 @@ DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. -PROJECT_NAME = "Jack2" +PROJECT_NAME = "LADI Jack Audio Connection Kit" # The PROJECT_NUMBER tag can be used to enter a project or revision number. # This could be handy for archiving the generated documentation or @@ -105,7 +105,7 @@ INLINE_INHERITED_MEMB = NO # path before files name in the file list and in the header files. If set # to NO the shortest path that makes the file name unique will be used. -FULL_PATH_NAMES = NO +FULL_PATH_NAMES = YES # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag # can be used to strip a user-defined part of the path. Stripping is @@ -786,7 +786,7 @@ HTML_FILE_EXTENSION = .html # each generated HTML page. If it is left blank doxygen will generate a # standard header. -HTML_HEADER = +HTML_HEADER = ../doc/doxygen-header.html # The HTML_FOOTER tag can be used to specify a personal HTML footer for # each generated HTML page. If it is left blank doxygen will generate a @@ -803,6 +803,13 @@ HTML_FOOTER = HTML_STYLESHEET = +HTML_EXTRA_STYLESHEET = ../doc/doxygen-awesome-css/doxygen-awesome.css + +#FULL_SIDEBAR = NO +HTML_COLORSTYLE = LIGHT # required with Doxygen >= 1.9.5 + +HTML_EXTRA_FILES = ../doc/doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js + # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML # page will contain the date and time when the page was generated. Setting # this to NO can help when comparing the output of multiple runs. @@ -977,7 +984,7 @@ ENUM_VALUES_PER_LINE = 4 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). # Windows users are probably better off using the HTML help feature. -GENERATE_TREEVIEW = NO +GENERATE_TREEVIEW = YES # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, # and Class Hierarchy pages using a tree view instead of an ordered list.