From: Vladimír Vondruš Date: Fri, 15 Dec 2017 17:53:51 +0000 (+0100) Subject: doxygen: introduce M_PAGE_FINE_PRINT, test the layout options. X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~cjwatson/git?a=commitdiff_plain;h=436c4b023bfffc7ae1fbea7ba9e17029813f8dd4;p=blog.git doxygen: introduce M_PAGE_FINE_PRINT, test the layout options. --- diff --git a/doc/doxygen.rst b/doc/doxygen.rst index 66f9fa51..79a8bdba 100644 --- a/doc/doxygen.rst +++ b/doc/doxygen.rst @@ -232,13 +232,19 @@ In addition, the m.css Doxygen theme recognizes the following extra options: Variable Description =================================== ======================================= :ini:`M_THEME_COLOR` Color for :html:``, - corresponding to the CSS style. See below - for more information. + corresponding to the CSS style. If empty, + no :html:`` tag is rendered. See + below for more information. :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 ``{filename}`` placeholder is replaced with current file name. +:ini:`M_PAGE_FINE_PRINT` HTML code to put into the footer. If not + set, a default generic text is used. The + ``{doxygen_version}`` placeholder is + replaced with Doxygen version that + generated the input XML files. :ini:`M_CLASS_TREE_EXPAND_LEVELS` How many levels of the class tree to expand. ``0`` means only the top-level symbols are shown. If not set, ``1`` is diff --git a/doxygen/dox2html5.py b/doxygen/dox2html5.py index e8f8bb32..5832f4ab 100755 --- a/doxygen/dox2html5.py +++ b/doxygen/dox2html5.py @@ -1846,6 +1846,7 @@ def parse_doxyfile(state: State, doxyfile, config = None): 'HTML_OUTPUT', 'XML_OUTPUT', 'M_PAGE_HEADER', + 'M_PAGE_FINE_PRINT', 'M_THEME_COLOR']: if i in config: state.doxyfile[i] = ' '.join(config[i]) diff --git a/doxygen/templates/base.html b/doxygen/templates/base.html index 161c17ca..24116db0 100644 --- a/doxygen/templates/base.html +++ b/doxygen/templates/base.html @@ -9,7 +9,9 @@ {% block header_links %} {% endblock %} + {% if M_THEME_COLOR %} + {% endif %}

@@ -50,7 +52,11 @@

+ {% if M_PAGE_FINE_PRINT %} + {{ M_PAGE_FINE_PRINT|replace('{doxygen_version}', DOXYGEN_VERSION) }} + {% else %}

{{ PROJECT_NAME }}{% if PROJECT_BRIEF %} {{ PROJECT_BRIEF }}{% endif %}. Created by Doxygen{% if M_SHOW_DOXYGEN_VERSION %} {{ DOXYGEN_VERSION }}{% endif %} and m.css.

+ {% endif %}

diff --git a/doxygen/test/layout/Doxyfile b/doxygen/test/layout/Doxyfile new file mode 100644 index 00000000..a7a22efe --- /dev/null +++ b/doxygen/test/layout/Doxyfile @@ -0,0 +1,8 @@ +XML_OUTPUT = + +PROJECT_NAME = "A project" +PROJECT_BRIEF = "is cool" + +M_THEME_COLOR = +M_PAGE_HEADER = "

A self link.

" +M_PAGE_FINE_PRINT = "

Doxygen version {doxygen_version}.

" diff --git a/doxygen/test/layout/index.html b/doxygen/test/layout/index.html new file mode 100644 index 00000000..f3811fe1 --- /dev/null +++ b/doxygen/test/layout/index.html @@ -0,0 +1,54 @@ + + + + + A project is cool + + + + + +

A self link.

+ A project +

+ + + diff --git a/doxygen/test/layout/indexpage.xml b/doxygen/test/layout/indexpage.xml new file mode 100644 index 00000000..6873eb23 --- /dev/null +++ b/doxygen/test/layout/indexpage.xml @@ -0,0 +1,11 @@ + + + + index + A project + + + + + + diff --git a/doxygen/test/test_layout.py b/doxygen/test/test_layout.py new file mode 100644 index 00000000..df87a8ad --- /dev/null +++ b/doxygen/test/test_layout.py @@ -0,0 +1,33 @@ +# +# This file is part of m.css. +# +# Copyright Â© 2017 VladimÃr VondruÅ¡ +# +# Permission is hereby granted, free of charge, to any person obtaining a +# copy of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included +# in all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL +# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +# DEALINGS IN THE SOFTWARE. +# + +from test import BaseTestCase + +class Layout(BaseTestCase): + def __init__(self, *args, **kwargs): + super().__init__(__file__, '', *args, **kwargs) + + def test(self): + self.run_dox2html5(wildcard='indexpage.xml') + self.assertEqual(*self.actual_expected_contents('index.html'))