Skip to content

Commit

Permalink
Update theme configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
diegoferigo committed May 21, 2021
1 parent 37c4fa0 commit 4e5e69e
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 8 deletions.
14 changes: 14 additions & 0 deletions docs/sphinx/_templates/versioning.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{% if versions %}
<nav id="bd-docs-nav" class="bd-links" aria-label="Versions navigation">
<div class="bd-toc-item active">
<p class="caption">
<span class="caption-text">{{ _('Doc Versions') }}</span>
</p>
<ul class="nav bd-sidenav">
{%- for item in versions %}
<li class="toctree-l1"><a class="reference internal" href="{{ item.url }}">{{ item.name }}</a></li>
{%- endfor %}
</ul>
</div>
</nav>
{% endif %}
17 changes: 10 additions & 7 deletions docs/sphinx/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,12 +72,15 @@
"use_edit_page_button": True,
"path_to_docs": "docs/sphinx",
"home_page_in_toc": True,
"use_download_button": False,
"use_fullscreen_button": True,
"single_page": False,
}

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# html_static_path = ['_static']

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'pastie'
Expand All @@ -99,18 +102,18 @@
# From: https://holzhaus.github.io/sphinx-multiversion
smv_prefer_remote_refs = False
smv_remote_whitelist = r'^(origin|upstream)$'
smv_tag_whitelist = None
smv_tag_whitelist = r'^dummy'
smv_branch_whitelist = r'^(master|devel|docs/.*)$'
smv_released_pattern = r'^tags/.*$'
smv_outputdir_format = '{ref.name}'

html_sidebars = {
"**": [
"about.html",
"navigation.html",
"versions.html",
"searchbox.html",
],
"sbt-sidebar-nav.html",
"versioning.html",
"search-field.html",
"sbt-sidebar-footer.html",
]
}

# -- Options for extlinks extension ----------------------------------
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
extras_require=dict(
website=[
"sphinx",
"sphinx-book-theme<0.0.39",
"sphinx-book-theme",
"sphinx-autodoc-typehints",
"sphinx_fontawesome",
"sphinx-multiversion",
Expand Down

0 comments on commit 4e5e69e

Please sign in to comment.