Skip to content

Commit

Permalink
Add version switcher, updt header location, link rtd versions
Browse files Browse the repository at this point in the history
  • Loading branch information
BradyPlanden committed Dec 14, 2023
1 parent a51d720 commit a0d44e5
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
17 changes: 17 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@
autoapi_member_order = "groupwise"

# -- Options for HTML output -------------------------------------------------
# Define the json_url for our version switcher.
json_url = "http://pybop-docs.readthedocs.io/en/latest/_static/switcher.json"
version_match = os.environ.get("READTHEDOCS_VERSION")

html_theme = "pydata_sphinx_theme"
html_show_sourcelink = False
html_title = "PyBOP Documentation"
Expand All @@ -66,7 +70,20 @@
],
"search_bar_text": "Search the docs...",
"show_prev_next": False,
"navbar_align": "content",
"navbar_center": ["navbar-nav", "version-switcher"],
"show_version_warning_banner": True,
"switcher": {
"json_url": json_url,
"version_match": version_match,
},
"footer_start": ["copyright"],
"footer_center": ["sphinx-version"],
}

html_static_path = ["_static"]
html_js_files = ["custom-icon.js"]

# -- Language ----------------------------------------------------------------

language = "en"
2 changes: 1 addition & 1 deletion noxfile.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import nox

# nox options
nox.options.reuse_existing_virtualenvs = False
nox.options.reuse_existing_virtualenvs = True


@nox.session
Expand Down

0 comments on commit a0d44e5

Please sign in to comment.