usov_i-org/bec
1
0
Fork 0
mirror of https://github.com/ivan-usov-org/bec.git synced 2025-04-22 02:20:02 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: added version switcher

Browse Source
This commit is contained in:
wakonig_k 2022-12-23 15:54:39 +01:00
parent e6beda3b9c
commit eaaff100a1
3 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/source/_static/switcher.json Normal file
View File

@ -0,0 +1,12 @@
[
{
"name": "production",
"version": "0.1",
"url": "https://beamline-experiment-control.readthedocs.io/en/production/index.html",
},
{
"name": "master",
"version": "0.1",
"url": "https://beamline-experiment-control.readthedocs.io/en/latest/index.html",
},
]

6
docs/source/conf.py
View File

@ -46,3 +46,9 @@ language = "Python"
# html_theme = 'alabaster' # html_theme = 'alabaster'
html_theme = "pydata_sphinx_theme" html_theme = "pydata_sphinx_theme"
html_static_path = ["_static"] html_static_path = ["_static"]
html_theme_options = {
"switcher": {
"json_url": "https://beamline-experiment-control.readthedocs.io/en/latest/_static/switcher.json",
},
"navbar_start": ["navbar-logo", "version-switcher"],
}

2
docs/source/index.rst
View File

@ -3,7 +3,7 @@
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
Welcome to BEC's documentation! Beamline Experiment Control
=============================== ===============================