diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..d8da1e4 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "doxygen-awesome-css"] + path = doxygen-awesome-css + url = https://github.com/jothepro/doxygen-awesome-css.git diff --git a/Doxyfile b/Doxyfile index 610ea14..14974a9 100644 --- a/Doxyfile +++ b/Doxyfile @@ -61,7 +61,7 @@ PROJECT_BRIEF = "A command line utility for reading sensor data over I2 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. -PROJECT_LOGO = +PROJECT_LOGO = ./doxygen-custom/inspacelogo.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 @@ -361,7 +361,7 @@ MARKDOWN_SUPPORT = YES # Minimum value: 0, maximum value: 99, default value: 5. # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. -TOC_INCLUDE_HEADINGS = 5 +TOC_INCLUDE_HEADINGS = 0 # The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to # generate identifiers for the Markdown headings. Note: Every identifier is @@ -943,7 +943,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = src +INPUT = src README.md INPUT += src/include # This tag can be used to specify the character encoding of the source files @@ -1115,7 +1115,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = +USE_MDFILE_AS_MAINPAGE = README.md # The Fortran standard specifies that for fixed formatted Fortran code all # characters from position 72 are to be considered as comment. A common @@ -1324,7 +1324,7 @@ HTML_HEADER = # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FOOTER = +HTML_FOOTER = doxygen-custom/footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of @@ -1354,7 +1354,9 @@ HTML_STYLESHEET = # documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = +HTML_EXTRA_STYLESHEET = doxygen-awesome-css/doxygen-awesome.css \ + doxygen-awesome-css/doxygen-awesome-sidebar-only.css \ + doxygen-custom/custom.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 @@ -1685,7 +1687,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 # When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the # FULL_SIDEBAR option determines if the side bar is limited to only the treeview diff --git a/doxygen-awesome-css b/doxygen-awesome-css new file mode 160000 index 0000000..df88fe4 --- /dev/null +++ b/doxygen-awesome-css @@ -0,0 +1 @@ +Subproject commit df88fe4fdd97714fadfd3ef17de0b4401f804052 diff --git a/doxygen-custom/custom.css b/doxygen-custom/custom.css new file mode 100644 index 0000000..7f4a338 --- /dev/null +++ b/doxygen-custom/custom.css @@ -0,0 +1,5 @@ +/* Resize to fix larger logo - formerly 335px x 120px */ +html { + --side-nav-fixed-width: 350px; + --top-height: 150px; +} diff --git a/doxygen-custom/footer.html b/doxygen-custom/footer.html new file mode 100644 index 0000000..4bcb641 --- /dev/null +++ b/doxygen-custom/footer.html @@ -0,0 +1,10 @@ + +
diff --git a/doxygen-custom/inspacelogo.png b/doxygen-custom/inspacelogo.png new file mode 100644 index 0000000..1bfa239 Binary files /dev/null and b/doxygen-custom/inspacelogo.png differ