From 78d5efffcde78e2e5d56434af9450581e99ed652 Mon Sep 17 00:00:00 2001 From: Daniel McCloy Date: Wed, 28 Jul 2021 10:15:00 -0500 Subject: [PATCH] add version switcher (cleaner diff this time) --- docs/_static/switcher.json | 97 ++++++++++++++++++++ docs/conf.py | 7 +- pydata_sphinx_theme/_templates/switcher.html | 50 ++++++++++ pydata_sphinx_theme/theme.conf | 4 +- 4 files changed, 155 insertions(+), 3 deletions(-) create mode 100644 docs/_static/switcher.json create mode 100644 pydata_sphinx_theme/_templates/switcher.html diff --git a/docs/_static/switcher.json b/docs/_static/switcher.json new file mode 100644 index 0000000000..252b23ceba --- /dev/null +++ b/docs/_static/switcher.json @@ -0,0 +1,97 @@ +[ + { + "name": "v0.6.3 (latest)", + "version": "latest", + "language": "en" + }, + { + "name": "v0.6.2", + "version": "v0.6.2", + "language": "en" + }, + { + "name": "v0.6.1", + "version": "v0.6.1", + "language": "en" + }, + { + "name": "v0.6.0", + "version": "v0.6.0", + "language": "en" + }, + { + "name": "v0.5.2", + "version": "v0.5.2", + "language": "en" + }, + { + "name": "v0.5.1", + "version": "v0.5.1", + "language": "en" + }, + { + "name": "v0.5.0", + "version": "v0.5.0", + "language": "en" + }, + { + "name": "v0.4.3", + "version": "v0.4.3", + "language": "en" + }, + { + "name": "v0.4.2", + "version": "v0.4.2", + "language": "en" + }, + { + "name": "v0.4.1", + "version": "v0.4.1", + "language": "en" + }, + { + "name": "v0.4.0", + "version": "v0.4.0", + "language": "en" + }, + { + "name": "v0.3.2", + "version": "v0.3.2", + "language": "en" + }, + { + "name": "v0.3.1", + "version": "v0.3.1", + "language": "en" + }, + { + "name": "v0.3.0", + "version": "v0.3.0", + "language": "en" + }, + { + "name": "v0.2.2", + "version": "v0.2.2", + "language": "en" + }, + { + "name": "v0.2.1", + "version": "v0.2.1", + "language": "en" + }, + { + "name": "v0.2.0", + "version": "v0.2.0", + "language": "en" + }, + { + "name": "v0.1.1", + "version": "v0.1.1", + "language": "en" + }, + { + "name": "v0.1.0", + "version": "v0.1.0", + "language": "en" + } +] diff --git a/docs/conf.py b/docs/conf.py index 9a9f8f208c..f6bb90d5f3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -23,7 +23,8 @@ import pydata_sphinx_theme -version = pydata_sphinx_theme.__version__.replace("dev0", "") +release = pydata_sphinx_theme.__version__ +version = release.replace("dev0", "") # -- General configuration --------------------------------------------------- @@ -81,7 +82,7 @@ # "navbar_align": "left", # [left, content, right] For testing that the navbar items align properly # "navbar_start": ["navbar-logo", "navbar-version"], # "navbar_center": ["navbar-nav", "navbar-version"], # Just for testing - # "navbar_end": ["navbar-icon-links", "navbar-version"] # Just for testing + "navbar_end": ["switcher", "navbar-icon-links"], # "footer_items": ["copyright", "sphinx-version", ""] } @@ -91,6 +92,8 @@ "github_repo": "pydata-sphinx-theme", "github_version": "master", "doc_path": "docs", + "switcher_json_url": "/_static/switcher.json", + "switcher_template_url": "https://pydata-sphinx-theme.readthedocs.io/{language}/{version}/", } # Add any paths that contain custom static files (such as style sheets) here, diff --git a/pydata_sphinx_theme/_templates/switcher.html b/pydata_sphinx_theme/_templates/switcher.html new file mode 100644 index 0000000000..0d78decd38 --- /dev/null +++ b/pydata_sphinx_theme/_templates/switcher.html @@ -0,0 +1,50 @@ + + + diff --git a/pydata_sphinx_theme/theme.conf b/pydata_sphinx_theme/theme.conf index 60f48f73cb..e389b62536 100644 --- a/pydata_sphinx_theme/theme.conf +++ b/pydata_sphinx_theme/theme.conf @@ -29,4 +29,6 @@ navbar_start = navbar-logo.html navbar_center = navbar-nav.html navbar_end = navbar-icon-links.html footer_items = copyright.html, sphinx-version.html -page_sidebar_items = page-toc.html, edit-this-page.html \ No newline at end of file +page_sidebar_items = page-toc.html, edit-this-page.html +switcher_json_url = +switcher_template_url =