diff options
| author | Andrew Godwin | 2022-11-25 17:44:10 -0700 |
|---|---|---|
| committer | Andrew Godwin | 2022-11-25 17:52:57 -0700 |
| commit | 2a8cb8f8617d618c8d2777cccd823b28a3edc812 (patch) | |
| tree | 48d36472bc25305821e3730b741be7e5a2e12946 /docs | |
| parent | cec9698326c504b39e0efacbc94338b6bf7121f0 (diff) | |
| download | takahe-2a8cb8f8617d618c8d2777cccd823b28a3edc812.tar.gz takahe-2a8cb8f8617d618c8d2777cccd823b28a3edc812.tar.bz2 takahe-2a8cb8f8617d618c8d2777cccd823b28a3edc812.zip | |
Switch to Furo docs theme
Fixes #42
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/_templates/extralinks.html | 7 | ||||
| -rw-r--r-- | docs/_templates/sidebar/brand.html | 23 | ||||
| -rw-r--r-- | docs/conf.py | 9 | ||||
| -rw-r--r-- | docs/requirements.txt | 1 |
4 files changed, 25 insertions, 15 deletions
diff --git a/docs/_templates/extralinks.html b/docs/_templates/extralinks.html deleted file mode 100644 index e8a0f35..0000000 --- a/docs/_templates/extralinks.html +++ /dev/null @@ -1,7 +0,0 @@ -<h3>Takahē</h3> -<ul> - <li><a href="https://jointakahe.org">Homepage</a></li> - <li><a href="https://takahe-server.readthedocs.io/">Documentation</a></li> - <li><a href="https://github.com/jointakahe/takahe">GitHub</a></li> - <li><a href="https://discord.gg/qvQ39tAMvf">Discord</a></li> -</ul> diff --git a/docs/_templates/sidebar/brand.html b/docs/_templates/sidebar/brand.html new file mode 100644 index 0000000..f6e47b1 --- /dev/null +++ b/docs/_templates/sidebar/brand.html @@ -0,0 +1,23 @@ +<a class="sidebar-brand{% if logo %} centered{% endif %}" href="{{ pathto(master_doc) }}"> + {% block brand_content %} + {%- if logo_url %} + <div class="sidebar-logo-container"> + <img class="sidebar-logo" src="{{ logo_url }}" alt="Takahē"/> + </div> + {%- endif %} + {%- if theme_light_logo and theme_dark_logo %} + <div class="sidebar-logo-container"> + <img class="sidebar-logo only-light" src="{{ pathto('_static/' + theme_light_logo, 1) }}" alt="Light Logo"/> + <img class="sidebar-logo only-dark" src="{{ pathto('_static/' + theme_dark_logo, 1) }}" alt="Dark Logo"/> + </div> + {%- endif %} + {% endblock brand_content %} + </a> +<div class="sidebar-tree" style="margin-top:0"> + <ul> + <li class="toctree-l1"><a class="reference" href="https://jointakahe.org">Homepage</a></li> + <li class="toctree-l1"><a class="reference" href="https://takahe-server.readthedocs.io/">Documentation</a></li> + <li class="toctree-l1"><a class="reference" href="https://github.com/jointakahe/takahe">GitHub</a></li> + <li class="toctree-l1"><a class="reference" href="https://discord.gg/qvQ39tAMvf">Discord</a></li> + </ul> +</div> diff --git a/docs/conf.py b/docs/conf.py index 480b95b..f269972 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -22,14 +22,7 @@ exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -html_theme = "nature" +html_theme = "furo" html_static_path = ["_static"] html_logo = "../static/img/logo-128.png" html_favicon = "../static/img/icon-32.png" -html_sidebars = { - "**": [ - "localtoc.html", - "extralinks.html", - "searchbox.html", - ] -} diff --git a/docs/requirements.txt b/docs/requirements.txt index 21ef954..b85468a 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1 +1,2 @@ sphinx~=5.3.0 +furo==2022.9.29 |