Add a logo to the C++ docs

This requires working around a bug in sphinx and the rtd theme, hence
the git pinning.
This commit is contained in:
Simon Hausmann 2021-06-25 10:28:38 +02:00
parent 40d8c7633f
commit f9ef21bffd
3 changed files with 9 additions and 2 deletions

View file

@ -6,9 +6,10 @@ verify_ssl = true
[dev-packages] [dev-packages]
[packages] [packages]
sphinx = "*"
breathe = "*" breathe = "*"
sphinx-rtd-theme = "*" # Upstream sphinx and sphinx-rtd-theme have a bug in not supporting html_logo urls, pull in prospective fix
sphinx-rtd-theme = {editable = true, ref = "logo-url-fix", git = "https://github.com/tronical/sphinx_rtd_theme.git"}
sphinx = {editable = true, ref = "logo-url-fix", git = "https://github.com/tronical/sphinx.git"}
exhale = "*" exhale = "*"
recommonmark = "*" recommonmark = "*"
sphinx-markdown-tables = "*" sphinx-markdown-tables = "*"

View file

@ -7,3 +7,7 @@
max-width: 100%; max-width: 100%;
overflow: visible; overflow: visible;
} }
img.logo {
max-height: 70px;
}

View file

@ -76,5 +76,7 @@ html_static_path = ['_static']
html_show_sourcelink = False html_show_sourcelink = False
html_logo = "https://sixtyfps.io/resources/logo.drawio.svg"
def setup(app): def setup(app):
app.add_css_file('theme_tweak.css') app.add_css_file('theme_tweak.css')