docs: add version switcher do documentation
This commit is contained in:
parent
7ce056b471
commit
083848261d
2 changed files with 32 additions and 3 deletions
11
docs/_static/versions.json
vendored
Normal file
11
docs/_static/versions.json
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"name": "dev",
|
||||||
|
"version": "dev",
|
||||||
|
"url": "https://anand-bala.github.io/argus/dev/"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"version": "v0.1.1",
|
||||||
|
"url": "https://anand-bala.github.io/argus/v0.1.1/"
|
||||||
|
},
|
||||||
|
]
|
||||||
24
docs/conf.py
24
docs/conf.py
|
|
@ -6,12 +6,20 @@
|
||||||
# -- Project information -----------------------------------------------------
|
# -- Project information -----------------------------------------------------
|
||||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
||||||
|
|
||||||
|
import os
|
||||||
|
|
||||||
project = "Argus"
|
project = "Argus"
|
||||||
copyright = "2023, Anand Balakrishnan"
|
copyright = "2023, Anand Balakrishnan"
|
||||||
author = "Anand Balakrishnan"
|
author = "Anand Balakrishnan"
|
||||||
|
|
||||||
version = "v0.1.1"
|
|
||||||
release = "0.1.1"
|
if os.environ.get("CI") is not None:
|
||||||
|
# In CI, use Github Action variables
|
||||||
|
version = os.environ["GITHUB_REF_NAME"]
|
||||||
|
else:
|
||||||
|
# running locally, just use "dev"
|
||||||
|
version = "dev"
|
||||||
|
release = version
|
||||||
|
|
||||||
extensions = [
|
extensions = [
|
||||||
"autoapi.extension",
|
"autoapi.extension",
|
||||||
|
|
@ -26,7 +34,17 @@ exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
|
||||||
|
|
||||||
html_theme = "pydata_sphinx_theme"
|
html_theme = "pydata_sphinx_theme"
|
||||||
html_static_path = ["_static"]
|
html_static_path = ["_static"]
|
||||||
html_theme_options = {"use_edit_page_button": True, "github_url": "https://github.com/anand-bala/argus"}
|
html_theme_options = {
|
||||||
|
"use_edit_page_button": True,
|
||||||
|
"github_url": "https://github.com/anand-bala/argus",
|
||||||
|
"switcher": {
|
||||||
|
"json_url": "https://anand-bala.github.io/argus/dev/_static/switcher.json",
|
||||||
|
"version_match": version,
|
||||||
|
},
|
||||||
|
"check_switcher": False,
|
||||||
|
"navbar_align": "left", # [left, content, right] For testing that the navbar items align properly
|
||||||
|
"navbar_center": ["version-switcher", "navbar-nav"],
|
||||||
|
}
|
||||||
html_context = {
|
html_context = {
|
||||||
"github_user": "anand-bala",
|
"github_user": "anand-bala",
|
||||||
"github_repo": "argus",
|
"github_repo": "argus",
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue