From 83a7ad2f284ec0e2341ec36d44cbacf2b63fd583 Mon Sep 17 00:00:00 2001 From: Martin Szulecki Date: Thu, 18 Jun 2020 20:20:58 +0200 Subject: docs: Add HTML templates for header/footer and layout config for documentation --- docs/doxygen/footer.html | 9 ++ docs/doxygen/header.html | 64 ++++++++++++++ docs/doxygen/layout.xml | 226 +++++++++++++++++++++++++++++++++++++++++++++++ doxygen.cfg.in | 6 +- 4 files changed, 302 insertions(+), 3 deletions(-) create mode 100644 docs/doxygen/footer.html create mode 100644 docs/doxygen/header.html create mode 100644 docs/doxygen/layout.xml diff --git a/docs/doxygen/footer.html b/docs/doxygen/footer.html new file mode 100644 index 0000000..9eef78d --- /dev/null +++ b/docs/doxygen/footer.html @@ -0,0 +1,9 @@ + + \ No newline at end of file diff --git a/docs/doxygen/header.html b/docs/doxygen/header.html new file mode 100644 index 0000000..bc41a11 --- /dev/null +++ b/docs/doxygen/header.html @@ -0,0 +1,64 @@ + + + + + + + +$title - $projectname $projectnumber +$title + + + + + + + + + + + + +$treeview +$search +$mathjax + +$extrastylesheet + + +
+ + +
+ + + + + + + + + + + + + + + + + + + + + +
+
$projectname +  $projectnumber +
+
$projectbrief - Return to Homepage
+
+
$projectbrief
+
$searchbox
+
+ + \ No newline at end of file diff --git a/docs/doxygen/layout.xml b/docs/doxygen/layout.xml new file mode 100644 index 0000000..46f068d --- /dev/null +++ b/docs/doxygen/layout.xml @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doxygen.cfg.in b/doxygen.cfg.in index e68611e..f07921b 100644 --- a/doxygen.cfg.in +++ b/doxygen.cfg.in @@ -731,7 +731,7 @@ FILE_VERSION_FILTER = # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. -LAYOUT_FILE = +LAYOUT_FILE = docs/doxygen/layout.xml # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib @@ -1126,7 +1126,7 @@ HTML_FILE_EXTENSION = .html # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_HEADER = +HTML_HEADER = docs/doxygen/header.html # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard @@ -1136,7 +1136,7 @@ HTML_HEADER = # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FOOTER = +HTML_FOOTER = docs/doxygen/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 -- cgit v1.1-32-gdbae