From f9376403e3a41fb143bfccb9feb9602489c635b7 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Fri, 12 Oct 2018 22:06:09 +0200 Subject: [PATCH] doxygen: make it possible to have separate brand link in navbar. --- doc/doxygen.rst | 5 ++ doxygen/dox2html5.py | 1 + doxygen/templates/base.html | 6 +++ .../layout_navbar_main_project_url/Doxyfile | 9 ++++ .../layout_navbar_main_project_url/index.html | 50 +++++++++++++++++++ .../indexpage.xml | 11 ++++ doxygen/test/test_layout.py | 8 +++ 7 files changed, 90 insertions(+) create mode 100644 doxygen/test/layout_navbar_main_project_url/Doxyfile create mode 100644 doxygen/test/layout_navbar_main_project_url/index.html create mode 100644 doxygen/test/layout_navbar_main_project_url/indexpage.xml diff --git a/doc/doxygen.rst b/doc/doxygen.rst index a1a6381c..da3efc4f 100644 --- a/doc/doxygen.rst +++ b/doc/doxygen.rst @@ -304,6 +304,11 @@ Variable Description `Navbar links`_ for more information. :ini:`M_LINKS_NAVBAR2` Right navbar column links. See `Navbar links`_ for more information. +:ini:`M_MAIN_PROJECT_URL` If set and :ini:`PROJECT_BRIEF` is also + set, then :ini:`PROJECT_NAME` in the top + navbar will link to this URL and + :ini:`PROJECT_BRIEF` into the documentation + main page, similarly as `shown here <{filename}/css/page-layout.rst#link-back-to-main-site-from-a-subsite>`_. :ini:`M_HTML_HEADER` HTML code to put at the end of the :html:`` element. Useful for linking arbitrary JavaScript code or, for example, diff --git a/doxygen/dox2html5.py b/doxygen/dox2html5.py index e53bf8fb..ff88aabf 100755 --- a/doxygen/dox2html5.py +++ b/doxygen/dox2html5.py @@ -2957,6 +2957,7 @@ list using ↓ and 'OUTPUT_DIRECTORY', 'HTML_OUTPUT', 'XML_OUTPUT', + 'M_MAIN_PROJECT_URL', 'M_HTML_HEADER', 'M_PAGE_HEADER', 'M_PAGE_FINE_PRINT', diff --git a/doxygen/templates/base.html b/doxygen/templates/base.html index db26ec0a..4820545a 100644 --- a/doxygen/templates/base.html +++ b/doxygen/templates/base.html @@ -23,7 +23,13 @@

+ {% if M_MAIN_PROJECT_URL and PROJECT_BRIEF %} + + {% else %} + {% endif %} {% if M_LINKS_NAVBAR1 or M_LINKS_NAVBAR2 or not M_SEARCH_DISABLED %}

{% if not M_SEARCH_DISABLED %} diff --git a/doxygen/test/layout_navbar_main_project_url/Doxyfile b/doxygen/test/layout_navbar_main_project_url/Doxyfile new file mode 100644 index 00000000..2f6b626b --- /dev/null +++ b/doxygen/test/layout_navbar_main_project_url/Doxyfile @@ -0,0 +1,9 @@ +XML_OUTPUT = +PROJECT_NAME = Your Brand +PROJECT_BRIEF = docs + +##! M_PAGE_FINE_PRINT = +##! M_THEME_COLOR = +##! M_FAVICON = +##! M_SEARCH_DISABLED = YES +##! M_MAIN_PROJECT_URL = http://your.brand diff --git a/doxygen/test/layout_navbar_main_project_url/index.html b/doxygen/test/layout_navbar_main_project_url/index.html new file mode 100644 index 00000000..010182b7 --- /dev/null +++ b/doxygen/test/layout_navbar_main_project_url/index.html @@ -0,0 +1,50 @@ + + + + + Your Brand | Your +Brand docs + + + + + +

+ Your Brand +

+ + \ No newline at end of file diff --git a/doxygen/test/layout_navbar_main_project_url/indexpage.xml b/doxygen/test/layout_navbar_main_project_url/indexpage.xml new file mode 100644 index 00000000..afdb7bfa --- /dev/null +++ b/doxygen/test/layout_navbar_main_project_url/indexpage.xml @@ -0,0 +1,11 @@ + + + + index + Your Brand + + + + + + diff --git a/doxygen/test/test_layout.py b/doxygen/test/test_layout.py index 5d108db2..005979c9 100644 --- a/doxygen/test/test_layout.py +++ b/doxygen/test/test_layout.py @@ -75,6 +75,14 @@ class NavbarHtml(BaseTestCase): self.run_dox2html5(wildcard='indexpage.xml') self.assertEqual(*self.actual_expected_contents('index.html')) +class NavbarMainProjectUrl(BaseTestCase): + def __init__(self, *args, **kwargs): + super().__init__(__file__, 'navbar_main_project_url', *args, **kwargs) + + def test(self): + self.run_dox2html5(wildcard='indexpage.xml') + self.assertEqual(*self.actual_expected_contents('index.html')) + class SearchBinary(BaseTestCase): def __init__(self, *args, **kwargs): super().__init__(__file__, 'search_binary', *args, **kwargs) -- 2.30.2