chiark / gitweb /
~cjwatson / blog.git / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 0131a05)
doxygen: support adding extra stuff to HTML <head>.
authorVladimír Vondruš <mosra@centrum.cz>
Thu, 11 Oct 2018 10:47:32 +0000 (12:47 +0200)
committerVladimír Vondruš <mosra@centrum.cz>
Thu, 11 Oct 2018 11:26:18 +0000 (13:26 +0200)
There's a new option for that: M_HTML_HEADER. Specify it as a multi-line
value for extra prettiness.

doc/doxygen.rst patch | blob | history
doxygen/dox2html5.py patch | blob | history
doxygen/templates/base.html patch | blob | history
doxygen/test/layout/Doxyfile patch | blob | history
doxygen/test/layout/pages.html patch | blob | history

diff --git a/doc/doxygen.rst b/doc/doxygen.rst
index ccacbb766354ea9293797f1a5318629e0386e33c..b2193e429e83e6bb69610f41150b41fa3ea54a90 100644 (file)
--- a/doc/doxygen.rst
+++ b/doc/doxygen.rst
@@ -304,6 +304,13 @@ Variable                            Description
                                     `Navbar links`_ for more information.
 :ini:`M_LINKS_NAVBAR2`              Right navbar column links. See
                                     `Navbar links`_ for more information.
+:ini:`M_HTML_HEADER`                HTML code to put at the end of the
+                                    :html:`<head>` element. Useful for linking
+                                    arbitrary JavaScript code or, for example,
+                                    adding :html:`<link>` CSS stylesheets with
+                                    additional properties and IDs that are
+                                    otherwise not possible with just
+                                    :ini:`HTML_EXTRA_STYLESHEET`
 :ini:`M_PAGE_HEADER`                HTML code to put at the top of every page.
                                     Useful for example to link to different
                                     versions of the same documentation. The
diff --git a/doxygen/dox2html5.py b/doxygen/dox2html5.py
index 31a3a0e9d15baf88de2043625940ef58bded2ac8..7d0abde887c8843eb7c66187fd5483fdafd5cf2c 100755 (executable)
--- a/doxygen/dox2html5.py
+++ b/doxygen/dox2html5.py
@@ -2935,6 +2935,7 @@ list using <span class="m-label m-dim">&darr;</span> and
               'OUTPUT_DIRECTORY',
               'HTML_OUTPUT',
               'XML_OUTPUT',
+              'M_HTML_HEADER',
               'M_PAGE_HEADER',
               'M_PAGE_FINE_PRINT',
               'M_THEME_COLOR',
diff --git a/doxygen/templates/base.html b/doxygen/templates/base.html
index f9173172090a3f01ad3fdfe80842f2aa7876ab42..205cbc33251983178448df209d264d622dd4713d 100644 (file)
--- a/doxygen/templates/base.html
+++ b/doxygen/templates/base.html
@@ -15,6 +15,9 @@
   {% if M_THEME_COLOR %}
   <meta name="theme-color" content="{{ M_THEME_COLOR }}" />
   {% endif %}
+  {% if M_HTML_HEADER %}
+  {{ M_HTML_HEADER|indent(2) }}
+  {% endif %}
 </head>
 <body>
 <header><nav id="navigation">
diff --git a/doxygen/test/layout/Doxyfile b/doxygen/test/layout/Doxyfile
index 0db4bb1df66e6838d210ff1c3eed1b145bc906eb..8fb935d6157bc2148ccf2b7ff94395eab5fed950 100644 (file)
--- a/doxygen/test/layout/Doxyfile
+++ b/doxygen/test/layout/Doxyfile
@@ -12,3 +12,6 @@ PROJECT_BRIEF = "is cool"
 ##! M_LINKS_NAVBAR2     = "pages pages annotated"
 ##! M_SEARCH_EXTERNAL_URL = "https://google.com/search?q=site:mcss.mosra.cz+{}"
 ##! M_SEARCH_HELP       = "Some <em>help</em>."
+##! M_HTML_HEADER       = "<!-- this is extra in the header -->" \
+##!                       "  <!-- and more, indented -->" \
+##!                       "<!-- yes. -->"
diff --git a/doxygen/test/layout/pages.html b/doxygen/test/layout/pages.html
index 9e354aa13e73a0a7b062e063e90b87923129ad5f..041d84662492ec143165e9e6fb1ad6ea1f57234b 100644 (file)
--- a/doxygen/test/layout/pages.html
+++ b/doxygen/test/layout/pages.html
@@ -8,6 +8,9 @@
   <link rel="icon" href="favicon-light.png" type="image/png" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <meta name="theme-color" content="00ffff" />
+  <!-- this is extra in the header -->
+    <!-- and more, indented -->
+  <!-- yes. -->
 </head>
 <body>
 <header><nav id="navigation">
Colin Watson's blog