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

diff --git a/documentation/templates/python/base.html b/documentation/templates/python/base.html index 09857cb8..11985d5a 100644 --- a/documentation/templates/python/base.html +++ b/documentation/templates/python/base.html @@ -28,10 +28,10 @@

{% if MAIN_PROJECT_URL and PROJECT_TITLE %} {% else %} - + {% endif %} {% if LINKS_NAVBAR1 or LINKS_NAVBAR2 or not SEARCH_DISABLED %}

diff --git a/documentation/test_doxygen/layout_navbar_project_logo/Doxyfile b/documentation/test_doxygen/layout_navbar_project_logo/Doxyfile new file mode 100644 index 00000000..c90504de --- /dev/null +++ b/documentation/test_doxygen/layout_navbar_project_logo/Doxyfile @@ -0,0 +1,10 @@ +XML_OUTPUT = +PROJECT_NAME = "Your Brand" +PROJECT_LOGO = mosra.jpg + +##! M_PAGE_FINE_PRINT = +##! M_THEME_COLOR = +##! M_FAVICON = +##! M_LINKS_NAVBAR1 = +##! M_LINKS_NAVBAR2 = +##! M_SEARCH_DISABLED = YES diff --git a/documentation/test_doxygen/layout_navbar_project_logo/index.html b/documentation/test_doxygen/layout_navbar_project_logo/index.html new file mode 100644 index 00000000..cdcf6574 --- /dev/null +++ b/documentation/test_doxygen/layout_navbar_project_logo/index.html @@ -0,0 +1,30 @@ + + + + + Your Brand + + + + + +

+ Your Brand +

+ + diff --git a/documentation/test_doxygen/layout_navbar_project_logo/indexpage.xml b/documentation/test_doxygen/layout_navbar_project_logo/indexpage.xml new file mode 100644 index 00000000..afdb7bfa --- /dev/null +++ b/documentation/test_doxygen/layout_navbar_project_logo/indexpage.xml @@ -0,0 +1,11 @@ + + + + index + Your Brand + + + + + + diff --git a/documentation/test_doxygen/layout_navbar_project_logo/mosra.jpg b/documentation/test_doxygen/layout_navbar_project_logo/mosra.jpg new file mode 120000 index 00000000..d474bc98 --- /dev/null +++ b/documentation/test_doxygen/layout_navbar_project_logo/mosra.jpg @@ -0,0 +1 @@ +../../../site/content/static/mosra.jpg \ No newline at end of file diff --git a/documentation/test_doxygen/layout_navbar_project_logo_main_project_url/Doxyfile b/documentation/test_doxygen/layout_navbar_project_logo_main_project_url/Doxyfile new file mode 100644 index 00000000..0bd7b951 --- /dev/null +++ b/documentation/test_doxygen/layout_navbar_project_logo_main_project_url/Doxyfile @@ -0,0 +1,12 @@ +XML_OUTPUT = +PROJECT_NAME = "Your Brand" +PROJECT_LOGO = mosra.jpg +PROJECT_BRIEF = docs + +##! M_PAGE_FINE_PRINT = +##! M_THEME_COLOR = +##! M_FAVICON = +##! M_LINKS_NAVBAR1 = +##! M_LINKS_NAVBAR2 = +##! M_SEARCH_DISABLED = YES +##! M_MAIN_PROJECT_URL = http://your.brand diff --git a/documentation/test_doxygen/layout_navbar_project_logo_main_project_url/index.html b/documentation/test_doxygen/layout_navbar_project_logo_main_project_url/index.html new file mode 100644 index 00000000..cd8cdf1d --- /dev/null +++ b/documentation/test_doxygen/layout_navbar_project_logo_main_project_url/index.html @@ -0,0 +1,32 @@ + + + + + Your Brand docs + + + + + +

+ Your Brand +

+ + diff --git a/documentation/test_doxygen/layout_navbar_project_logo_main_project_url/indexpage.xml b/documentation/test_doxygen/layout_navbar_project_logo_main_project_url/indexpage.xml new file mode 100644 index 00000000..afdb7bfa --- /dev/null +++ b/documentation/test_doxygen/layout_navbar_project_logo_main_project_url/indexpage.xml @@ -0,0 +1,11 @@ + + + + index + Your Brand + + + + + + diff --git a/documentation/test_doxygen/layout_navbar_project_logo_main_project_url/mosra.jpg b/documentation/test_doxygen/layout_navbar_project_logo_main_project_url/mosra.jpg new file mode 120000 index 00000000..d474bc98 --- /dev/null +++ b/documentation/test_doxygen/layout_navbar_project_logo_main_project_url/mosra.jpg @@ -0,0 +1 @@ +../../../site/content/static/mosra.jpg \ No newline at end of file diff --git a/documentation/test_doxygen/test_doxyfile.py b/documentation/test_doxygen/test_doxyfile.py index 3d8b8f0e..0a9a7adb 100644 --- a/documentation/test_doxygen/test_doxyfile.py +++ b/documentation/test_doxygen/test_doxyfile.py @@ -77,6 +77,7 @@ copy a link to the result using â 'M_THEME_COLOR': '#22272e', 'OUTPUT_DIRECTORY': '', 'PROJECT_BRIEF': 'is cool', + 'PROJECT_LOGO': '', 'PROJECT_NAME': 'My Pet Project', 'SHOW_INCLUDE_FILES': True, 'XML_OUTPUT': 'xml' diff --git a/documentation/test_doxygen/test_layout.py b/documentation/test_doxygen/test_layout.py index e9d7fb12..db48147c 100644 --- a/documentation/test_doxygen/test_layout.py +++ b/documentation/test_doxygen/test_layout.py @@ -92,6 +92,22 @@ class NavbarMainProjectUrl(BaseTestCase): self.run_doxygen(wildcard='indexpage.xml') self.assertEqual(*self.actual_expected_contents('index.html')) +class NavbarProjectLogo(BaseTestCase): + def __init__(self, *args, **kwargs): + super().__init__(__file__, 'navbar_project_logo', *args, **kwargs) + + def test(self): + self.run_doxygen(wildcard='indexpage.xml') + self.assertEqual(*self.actual_expected_contents('index.html')) + +class NavbarProjectLogoMainProjectUrl(BaseTestCase): + def __init__(self, *args, **kwargs): + super().__init__(__file__, 'navbar_project_logo_main_project_url', *args, **kwargs) + + def test(self): + self.run_doxygen(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) diff --git a/documentation/test_python/layout_project_logo/index.html b/documentation/test_python/layout_project_logo/index.html new file mode 100644 index 00000000..b6902a10 --- /dev/null +++ b/documentation/test_python/layout_project_logo/index.html @@ -0,0 +1,30 @@ + + + + + My Python Project | My Python Project + + + + + +

+ My Python Project +

+ + diff --git a/documentation/test_python/layout_project_logo/mosra.jpg b/documentation/test_python/layout_project_logo/mosra.jpg new file mode 120000 index 00000000..d474bc98 --- /dev/null +++ b/documentation/test_python/layout_project_logo/mosra.jpg @@ -0,0 +1 @@ +../../../site/content/static/mosra.jpg \ No newline at end of file diff --git a/documentation/test_python/layout_project_logo_main_project_url/index.html b/documentation/test_python/layout_project_logo_main_project_url/index.html new file mode 100644 index 00000000..cbd1618e --- /dev/null +++ b/documentation/test_python/layout_project_logo_main_project_url/index.html @@ -0,0 +1,32 @@ + + + + + My Python Project | My Python Project docs + + + + + +

+ My Python Project +

+ + diff --git a/documentation/test_python/layout_project_logo_main_project_url/mosra.jpg b/documentation/test_python/layout_project_logo_main_project_url/mosra.jpg new file mode 120000 index 00000000..d474bc98 --- /dev/null +++ b/documentation/test_python/layout_project_logo_main_project_url/mosra.jpg @@ -0,0 +1 @@ +../../../site/content/static/mosra.jpg \ No newline at end of file diff --git a/documentation/test_python/test_layout.py b/documentation/test_python/test_layout.py index 7afaa6f0..06f376c3 100644 --- a/documentation/test_python/test_layout.py +++ b/documentation/test_python/test_layout.py @@ -84,3 +84,19 @@ class SearchOpenSearch(BaseTestCase): self.assertEqual(*self.actual_expected_contents('index.html')) self.assertTrue(os.path.exists(os.path.join(self.path, 'output', 'search-v1.js'))) self.assertEqual(*self.actual_expected_contents('opensearch.xml')) + +class ProjectLogo(BaseTestCase): + def test(self): + self.run_python({ + 'PROJECT_LOGO': 'mosra.jpg', + }) + self.assertEqual(*self.actual_expected_contents('index.html')) + +class ProjectLogoMainProjectUrl(BaseTestCase): + def test(self): + self.run_python({ + 'PROJECT_LOGO': 'mosra.jpg', + 'PROJECT_SUBTITLE': 'docs', + 'MAIN_PROJECT_URL': 'http://your.brand' + }) + self.assertEqual(*self.actual_expected_contents('index.html')) diff --git a/pelican-theme/templates/base.html b/pelican-theme/templates/base.html index 71442dfb..789d31a2 100644 --- a/pelican-theme/templates/base.html +++ b/pelican-theme/templates/base.html @@ -44,7 +44,7 @@

{% if M_LINKS_NAVBAR1 or M_LINKS_NAVBAR2 %} diff --git a/pelican-theme/test/layout_brand_logo/index.html b/pelican-theme/test/layout_brand_logo/index.html new file mode 100644 index 00000000..0f2fc92e --- /dev/null +++ b/pelican-theme/test/layout_brand_logo/index.html @@ -0,0 +1,37 @@ + + + + + Brand Logo | A Pelican Blog + + + + + + + + + + + + +

Brand Logo

+ + diff --git a/pelican-theme/test/layout_brand_logo/index.rst b/pelican-theme/test/layout_brand_logo/index.rst new file mode 100644 index 00000000..345b81c4 --- /dev/null +++ b/pelican-theme/test/layout_brand_logo/index.rst @@ -0,0 +1,4 @@ +Brand Logo +########## + +:save_as: index.html diff --git a/pelican-theme/test/layout_brand_logo/mosra.jpg b/pelican-theme/test/layout_brand_logo/mosra.jpg new file mode 120000 index 00000000..d474bc98 --- /dev/null +++ b/pelican-theme/test/layout_brand_logo/mosra.jpg @@ -0,0 +1 @@ +../../../site/content/static/mosra.jpg \ No newline at end of file diff --git a/pelican-theme/test/test_layout.py b/pelican-theme/test/test_layout.py index 9e59a97a..2abc9da6 100644 --- a/pelican-theme/test/test_layout.py +++ b/pelican-theme/test/test_layout.py @@ -241,3 +241,28 @@ class GlobalSocialMeta(BaseTestCase): # different og:url but nothing else. self.assertEqual(*self.actual_expected_contents('index.html')) self.assertEqual(*self.actual_expected_contents('archives.html')) + +class BrandLogo(MinimalTestCase): + def __init__(self, *args, **kwargs): + super().__init__(__file__, 'brand_logo', *args, **kwargs) + + def test(self): + self.run_pelican({ + # This is the minimal that's required. Not even the M_THEME_COLOR + # is required. + 'THEME': '.', + 'PLUGIN_PATHS': ['../plugins'], + 'PLUGINS': ['m.htmlsanity'], + 'THEME_STATIC_DIR': 'static', + 'M_CSS_FILES': ['https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i', + 'static/m-dark.css'], + 'M_SITE_LOGO': 'mosra.jpg', + 'STATIC_PATHS': ['mosra.jpg'], + 'ARTICLE_PATHS': ['articles'], # doesn't exist + # Supplying empty index.html to avoid excessive hello world markup + # we don't need + 'PAGE_PATHS': ['.'], + 'M_FINE_PRINT': ''}) + + # The archives and index page should be exactly the same + self.assertEqual(*self.actual_expected_contents('index.html'))