From 13319f10d47cf97c97285fcf0759595a23ad289c Mon Sep 17 00:00:00 2001 From: David Stansby Date: Tue, 16 Jan 2024 15:21:19 +0000 Subject: [PATCH 1/7] Bump pydata-sphinx-theme to 0.15 --- environment.yml | 2 +- requirements/doc/doc-requirements.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/environment.yml b/environment.yml index 3e9b79c35845..2930ccf17e83 100644 --- a/environment.yml +++ b/environment.yml @@ -34,7 +34,7 @@ dependencies: - ipywidgets - numpydoc>=1.0 - packaging>=20 - - pydata-sphinx-theme~=0.13.1 + - pydata-sphinx-theme~=0.15.0 - pyyaml - sphinx>=3.0.0,!=6.1.2 - sphinx-copybutton diff --git a/requirements/doc/doc-requirements.txt b/requirements/doc/doc-requirements.txt index 6b7f7c333787..173fa30eafbf 100644 --- a/requirements/doc/doc-requirements.txt +++ b/requirements/doc/doc-requirements.txt @@ -14,7 +14,7 @@ ipywidgets ipykernel numpydoc>=1.0 packaging>=20 -pydata-sphinx-theme~=0.13.1 +pydata-sphinx-theme~=0.15.0 mpl-sphinx-theme~=3.8.0 pyyaml sphinxcontrib-svg2pdfconverter>=1.1.0 From b68ed22875f9fdc7fe59ac4258df89effab48101 Mon Sep 17 00:00:00 2001 From: David Stansby Date: Tue, 16 Jan 2024 15:21:33 +0000 Subject: [PATCH 2/7] Fix search button placement in navbar --- doc/conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/conf.py b/doc/conf.py index ccde74304eb3..cfe03e6c2f9c 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -492,6 +492,7 @@ def js_tag_with_cache_busting(js): else 'devdocs') }, "navbar_end": ["theme-switcher", "version-switcher", "mpl_icon_links"], + "navbar_persistent": ["search-button"], "secondary_sidebar_items": "page-toc.html", "footer_start": ["copyright", "sphinx-version", "doc_version"], # We override the announcement template from pydata-sphinx-theme, where From 6f9eda7b1f3118e49603bccf0d2422334753c6e7 Mon Sep 17 00:00:00 2001 From: David Stansby Date: Tue, 16 Jan 2024 17:23:22 +0000 Subject: [PATCH 3/7] Fix doc sidebar --- doc/conf.py | 1 - 1 file changed, 1 deletion(-) diff --git a/doc/conf.py b/doc/conf.py index cfe03e6c2f9c..54b34916d57b 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -493,7 +493,6 @@ def js_tag_with_cache_busting(js): }, "navbar_end": ["theme-switcher", "version-switcher", "mpl_icon_links"], "navbar_persistent": ["search-button"], - "secondary_sidebar_items": "page-toc.html", "footer_start": ["copyright", "sphinx-version", "doc_version"], # We override the announcement template from pydata-sphinx-theme, where # this special value indicates the use of the unreleased banner. If we need From bc2c8721adffcc907b551988ce95b1db9d66eb04 Mon Sep 17 00:00:00 2001 From: David Stansby Date: Mon, 4 Mar 2024 21:00:00 +0000 Subject: [PATCH 4/7] Fix version switcher url for circleCI --- doc/conf.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/doc/conf.py b/doc/conf.py index 54b34916d57b..bab959bc9e28 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -484,7 +484,13 @@ def js_tag_with_cache_busting(js): # the server, but will be used as part of the key for caching by browsers # so when we do a new meso release the switcher will update "promptly" on # the stable and devdocs. - "json_url": f"https://matplotlib.org/devdocs/_static/switcher.json?{SHA}", + "json_url": ( + "https://output.circle-artifacts.com/output/job/" + f"{os.environ['CIRCLE_WORKFLOW_JOB_ID']}/artifacts/" + f"{os.environ['CIRCLE_NODE_INDEX']}" + "/doc/build/html/_static/switcher.json" if CIRCLECI else + f"https://matplotlib.org/devdocs/_static/switcher.json?{SHA}" + ), "version_match": ( # The start version to show. This must be in switcher.json. # We either go to 'stable' or to 'devdocs' From 591cd650b39f8bbfb445e10f4b72ecec08309e62 Mon Sep 17 00:00:00 2001 From: David Stansby Date: Mon, 4 Mar 2024 21:03:17 +0000 Subject: [PATCH 5/7] Don't use custom CSS for announcement banner --- doc/_static/mpl.css | 23 ----------------------- 1 file changed, 23 deletions(-) diff --git a/doc/_static/mpl.css b/doc/_static/mpl.css index 2c43bcfa7a3d..aae167d1f6f8 100644 --- a/doc/_static/mpl.css +++ b/doc/_static/mpl.css @@ -14,29 +14,6 @@ margin: 0; } -/* Make announcement an error colour for unreleased documentation, and sticky. */ -#unreleased-message.bd-header-announcement { - border-bottom: solid var(--pst-color-danger-highlight); - color: var(--pst-color-danger-text); - font-weight: var(--pst-admonition-font-weight-heading); - position: sticky; - top: 0; - z-index: 1050; -} - -#unreleased-message.bd-header-announcement:after { - background-color: var(--pst-color-danger); - opacity: 1; -} - -#unreleased-message.bd-header-announcement a { - color: var(--pst-color-danger-text); -} - -#unreleased-message.bd-header-announcement + .bd-navbar { - top: 3rem; /* Minimum height of announcement header. */ -} - /* multi column TOC */ .contents ul { list-style-type: none; From f178f5c52ab5a518cd9655633d876442a5f4b9df Mon Sep 17 00:00:00 2001 From: David Stansby Date: Mon, 4 Mar 2024 22:09:14 +0000 Subject: [PATCH 6/7] Disable parallel build --- .circleci/config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 2d7c0da457ec..468bec6eee7d 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -147,7 +147,7 @@ commands: export RELEASE_TAG='-t release' fi mkdir -p logs - make html O="-T $RELEASE_TAG -j4 -w /tmp/sphinxerrorswarnings.log" + make html O="-T $RELEASE_TAG -j1 -w /tmp/sphinxerrorswarnings.log" rm -r build/html/_sources working_directory: doc - save_cache: From c908cd43a833c97b183abdc60f053e3b33edfef6 Mon Sep 17 00:00:00 2001 From: David Stansby Date: Wed, 6 Mar 2024 11:17:27 +0000 Subject: [PATCH 7/7] Don't show doc source link --- doc/conf.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/conf.py b/doc/conf.py index bab959bc9e28..4241ada05cf4 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -200,6 +200,7 @@ def _check_dependencies(): missing_references_write_json = False missing_references_warn_unused_ignores = False + intersphinx_mapping = { 'Pillow': ('https://pillow.readthedocs.io/en/stable/', None), 'cycler': ('https://matplotlib.org/cycler/', None), @@ -549,6 +550,9 @@ def js_tag_with_cache_busting(js): # '**': ['localtoc.html', 'pagesource.html'] } +# Don't include link to doc source files +html_show_sourcelink = False + # Copies only relevant code, not the '>>>' prompt copybutton_prompt_text = r'>>> |\.\.\. ' copybutton_prompt_is_regexp = True