mirrors/takahe
1
1
Fork 0
mirror of https://github.com/jointakahe/takahe.git synced 2024-11-25 08:41:00 +00:00
Code Issues Projects Releases Packages Wiki Activity

Switch to Furo docs theme

Browse source 
Fixes #42
This commit is contained in:
Andrew Godwin 2022-11-25 17:44:10 -07:00
parent cec9698326
commit 2a8cb8f861
4 changed files with 25 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/_templates/extralinks.html vendored
View file

@ -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>

23
docs/_templates/sidebar/brand.html vendored Normal file
View file

@ -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>

9
docs/conf.py
View file

@ -22,14 +22,7 @@ exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
# -- Options for HTML output ------------------------------------------------- # -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#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_static_path = ["_static"]
html_logo = "../static/img/logo-128.png" html_logo = "../static/img/logo-128.png"
html_favicon = "../static/img/icon-32.png" html_favicon = "../static/img/icon-32.png"
html_sidebars = {
"**": [
"localtoc.html",
"extralinks.html",
"searchbox.html",
]
}

1
docs/requirements.txt
View file

@ -1 +1,2 @@
sphinx~=5.3.0 sphinx~=5.3.0
furo==2022.9.29