From 84d05620a866f5e284f77406d52bcdefcc26a7cb Mon Sep 17 00:00:00 2001 From: Daniel McCloy Date: Wed, 28 Jul 2021 10:15:00 -0500 Subject: [PATCH 01/27] 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 000000000..252b23ceb --- /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 da3335521..df66fab44 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -24,7 +24,8 @@ import pydata_sphinx_theme -version = pydata_sphinx_theme.__version__.replace("dev0", "") +release = pydata_sphinx_theme.__version__ +version = release.replace("dev0", "") # -- General configuration --------------------------------------------------- @@ -96,7 +97,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", ""] } @@ -106,6 +107,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 000000000..0d78decd3 --- /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 aee05fa65..dbffc411c 100644 --- a/pydata_sphinx_theme/theme.conf +++ b/pydata_sphinx_theme/theme.conf @@ -31,4 +31,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 = From 5f4a02379065496f10762c2fc5e50d7a5d7ad11c Mon Sep 17 00:00:00 2001 From: Daniel McCloy Date: Tue, 10 Aug 2021 16:23:29 -0500 Subject: [PATCH 02/27] remove unreachable ancient versions --- docs/_static/switcher.json | 25 ------------------------- 1 file changed, 25 deletions(-) diff --git a/docs/_static/switcher.json b/docs/_static/switcher.json index 252b23ceb..0c967b9c8 100644 --- a/docs/_static/switcher.json +++ b/docs/_static/switcher.json @@ -68,30 +68,5 @@ "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" } ] From 93b0aa09526a9802bf06594cd7e70dd932734fed Mon Sep 17 00:00:00 2001 From: Daniel McCloy Date: Tue, 10 Aug 2021 16:41:16 -0500 Subject: [PATCH 03/27] fallback on version if name missing --- pydata_sphinx_theme/_templates/switcher.html | 3 +++ 1 file changed, 3 insertions(+) diff --git a/pydata_sphinx_theme/_templates/switcher.html b/pydata_sphinx_theme/_templates/switcher.html index 0d78decd3..6df6289e5 100644 --- a/pydata_sphinx_theme/_templates/switcher.html +++ b/pydata_sphinx_theme/_templates/switcher.html @@ -31,6 +31,9 @@ // correct (for now, links will go to doc version homepage) $.each(data, function(index, entry) { entry.url = buildURL("{{ switcher_template_url }}", entry); + if (!("name" in entry)) { + entry.name = entry.version; + } $("#switcher").append(`${entry.name}`); }); // see if the current page exists in the other versions of the docs From e913a4855078f74bacc2f37ea54043b7c58bb0ed Mon Sep 17 00:00:00 2001 From: Daniel McCloy Date: Tue, 10 Aug 2021 17:03:00 -0500 Subject: [PATCH 04/27] simplify redundancies in switcher.json --- docs/_static/switcher.json | 15 +-------------- 1 file changed, 1 insertion(+), 14 deletions(-) diff --git a/docs/_static/switcher.json b/docs/_static/switcher.json index 0c967b9c8..d696bd660 100644 --- a/docs/_static/switcher.json +++ b/docs/_static/switcher.json @@ -1,71 +1,58 @@ [ { "name": "v0.6.3 (latest)", - "version": "latest", + "version": "v0.6.3", "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" } From cefafeb1ae739b7b4e2f626672df23b6339f9843 Mon Sep 17 00:00:00 2001 From: Daniel McCloy Date: Fri, 3 Sep 2021 18:33:51 -0500 Subject: [PATCH 05/27] separate out version switcher --- docs/_static/switcher.json | 57 +++++++++--- docs/conf.py | 2 +- pydata_sphinx_theme/_templates/switcher.html | 53 ----------- .../_templates/version-switcher.html | 90 +++++++++++++++++++ 4 files changed, 134 insertions(+), 68 deletions(-) delete mode 100644 pydata_sphinx_theme/_templates/switcher.html create mode 100644 pydata_sphinx_theme/_templates/version-switcher.html diff --git a/docs/_static/switcher.json b/docs/_static/switcher.json index d696bd660..a37d7b9ea 100644 --- a/docs/_static/switcher.json +++ b/docs/_static/switcher.json @@ -2,58 +2,87 @@ { "name": "v0.6.3 (latest)", "version": "v0.6.3", - "language": "en" + "languages": { + "en": "English", + "zh": "中文" + } }, { "version": "v0.6.2", - "language": "en" + "languages": { + "en": "English" + } }, { "version": "v0.6.1", - "language": "en" + "languages": { + "en": "English" + } }, { "version": "v0.6.0", - "language": "en" + "languages": { + "en": "English" + } }, { "version": "v0.5.2", - "language": "en" + "languages": { + "en": "English" + } }, { "version": "v0.5.1", - "language": "en" + "languages": { + "en": "English" + } }, { "version": "v0.5.0", - "language": "en" + "languages": { + "en": "English" + } }, { "version": "v0.4.3", - "language": "en" + "languages": { + "en": "English" + } }, { "version": "v0.4.2", - "language": "en" + "languages": { + "en": "English" + } }, { "version": "v0.4.1", - "language": "en" + "languages": { + "en": "English" + } }, { "version": "v0.4.0", - "language": "en" + "languages": { + "en": "English" + } }, { "version": "v0.3.2", - "language": "en" + "languages": { + "en": "English" + } }, { "version": "v0.3.1", - "language": "en" + "languages": { + "en": "English" + } }, { "version": "v0.3.0", - "language": "en" + "languages": { + "en": "English" + } } ] diff --git a/docs/conf.py b/docs/conf.py index df66fab44..32555f683 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -97,7 +97,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": ["switcher", "navbar-icon-links"], + "navbar_end": ["version-switcher", "navbar-icon-links"], # "footer_items": ["copyright", "sphinx-version", ""] } diff --git a/pydata_sphinx_theme/_templates/switcher.html b/pydata_sphinx_theme/_templates/switcher.html deleted file mode 100644 index 6df6289e5..000000000 --- a/pydata_sphinx_theme/_templates/switcher.html +++ /dev/null @@ -1,53 +0,0 @@ - - - diff --git a/pydata_sphinx_theme/_templates/version-switcher.html b/pydata_sphinx_theme/_templates/version-switcher.html new file mode 100644 index 000000000..9c638cd77 --- /dev/null +++ b/pydata_sphinx_theme/_templates/version-switcher.html @@ -0,0 +1,90 @@ + + + From 0f1275796dbe3236f1b53e3bda003ba87649101a Mon Sep 17 00:00:00 2001 From: Daniel McCloy Date: Mon, 25 Oct 2021 11:48:15 -0500 Subject: [PATCH 06/27] remove language-related stuff --- docs/_static/switcher.json | 71 ++++--------------- docs/conf.py | 2 +- .../_templates/version-switcher.html | 40 ----------- 3 files changed, 15 insertions(+), 98 deletions(-) diff --git a/docs/_static/switcher.json b/docs/_static/switcher.json index a37d7b9ea..c1d780e74 100644 --- a/docs/_static/switcher.json +++ b/docs/_static/switcher.json @@ -1,88 +1,45 @@ [ { "name": "v0.6.3 (latest)", - "version": "v0.6.3", - "languages": { - "en": "English", - "zh": "中文" - } + "version": "v0.6.3" }, { - "version": "v0.6.2", - "languages": { - "en": "English" - } + "version": "v0.6.2" }, { - "version": "v0.6.1", - "languages": { - "en": "English" - } + "version": "v0.6.1" }, { - "version": "v0.6.0", - "languages": { - "en": "English" - } + "version": "v0.6.0" }, { - "version": "v0.5.2", - "languages": { - "en": "English" - } + "version": "v0.5.2" }, { - "version": "v0.5.1", - "languages": { - "en": "English" - } + "version": "v0.5.1" }, { - "version": "v0.5.0", - "languages": { - "en": "English" - } + "version": "v0.5.0" }, { - "version": "v0.4.3", - "languages": { - "en": "English" - } + "version": "v0.4.3" }, { - "version": "v0.4.2", - "languages": { - "en": "English" - } + "version": "v0.4.2" }, { - "version": "v0.4.1", - "languages": { - "en": "English" - } + "version": "v0.4.1" }, { - "version": "v0.4.0", - "languages": { - "en": "English" - } + "version": "v0.4.0" }, { - "version": "v0.3.2", - "languages": { - "en": "English" - } + "version": "v0.3.2" }, { - "version": "v0.3.1", - "languages": { - "en": "English" - } + "version": "v0.3.1" }, { - "version": "v0.3.0", - "languages": { - "en": "English" - } + "version": "v0.3.0" } ] diff --git a/docs/conf.py b/docs/conf.py index 32555f683..daaa42c41 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -108,7 +108,7 @@ "github_version": "master", "doc_path": "docs", "switcher_json_url": "/_static/switcher.json", - "switcher_template_url": "https://pydata-sphinx-theme.readthedocs.io/{language}/{version}/", + "switcher_template_url": "https://pydata-sphinx-theme.readthedocs.io/en/{version}/", } # Add any paths that contain custom static files (such as style sheets) here, diff --git a/pydata_sphinx_theme/_templates/version-switcher.html b/pydata_sphinx_theme/_templates/version-switcher.html index 9c638cd77..fcb305c52 100644 --- a/pydata_sphinx_theme/_templates/version-switcher.html +++ b/pydata_sphinx_theme/_templates/version-switcher.html @@ -9,68 +9,28 @@