From 081d3c1c0cd30fb150a1a53130751e96f5939d59 Mon Sep 17 00:00:00 2001 From: Deepak Cherian Date: Wed, 21 Aug 2024 19:29:03 -0600 Subject: [PATCH 1/5] [skip-ci] Try speeding up docs build Following https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/performance.html --- ci/requirements/doc.yml | 1 + doc/conf.py | 4 ++++ 2 files changed, 5 insertions(+) diff --git a/ci/requirements/doc.yml b/ci/requirements/doc.yml index d0484c5e999..382ee54de6b 100644 --- a/ci/requirements/doc.yml +++ b/ci/requirements/doc.yml @@ -44,5 +44,6 @@ dependencies: - zarr>=2.10 - pip: - sphinxcontrib-mermaid + - sphinx-remove-toctrees # relative to this file. Needs to be editable to be accepted. - -e ../.. diff --git a/doc/conf.py b/doc/conf.py index 93a0e459a33..899a5f9ec67 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -88,6 +88,7 @@ "sphinxext.rediraffe", "sphinx_design", "sphinx_inline_tabs", + "sphinx_remove_toctrees", ] @@ -198,6 +199,8 @@ # The master toctree document. master_doc = "index" +remove_from_toctrees = ["generated/*"] + # General information about the project. project = "xarray" copyright = f"2014-{datetime.datetime.now().year}, xarray Developers" @@ -244,6 +247,7 @@ repository_url="https://github.com/pydata/xarray", repository_branch="main", navigation_with_keys=False, # pydata/pydata-sphinx-theme#1492 + navigation_depth=2, # speeds up the build path_to_docs="doc", use_edit_page_button=True, use_repository_button=True, From acefea2697b2434e3d85320c2360effb0863fc49 Mon Sep 17 00:00:00 2001 From: Deepak Cherian Date: Wed, 21 Aug 2024 20:48:16 -0600 Subject: [PATCH 2/5] bump to 3.12 --- ci/requirements/doc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ci/requirements/doc.yml b/ci/requirements/doc.yml index 382ee54de6b..7ae1c8c2626 100644 --- a/ci/requirements/doc.yml +++ b/ci/requirements/doc.yml @@ -4,7 +4,7 @@ channels: - conda-forge - nodefaults dependencies: - - python=3.10 + - python=3.12 - bottleneck - cartopy - cfgrib From 10a44160aa9c593cd569ff07d39283c1de686996 Mon Sep 17 00:00:00 2001 From: Deepak Cherian Date: Wed, 21 Aug 2024 20:53:15 -0600 Subject: [PATCH 3/5] [skip-ci] latest mamba --- .readthedocs.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 55fea717f71..46d861de3bb 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,9 +1,9 @@ version: 2 build: - os: ubuntu-22.04 + os: ubuntu-lts-latest tools: - python: mambaforge-4.10 + python: mambaforge-latest jobs: post_checkout: - (git --no-pager log --pretty="tformat:%s" -1 | grep -vqF "[skip-rtd]") || exit 183 From af8defdc7e5115ed67ce7110d3ce8f47050e495b Mon Sep 17 00:00:00 2001 From: Deepak Cherian Date: Wed, 28 Aug 2024 11:37:22 -0600 Subject: [PATCH 4/5] Use mamba --- ci/requirements/doc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ci/requirements/doc.yml b/ci/requirements/doc.yml index 7ae1c8c2626..9cc7781383c 100644 --- a/ci/requirements/doc.yml +++ b/ci/requirements/doc.yml @@ -39,11 +39,11 @@ dependencies: - sphinx-design - sphinx-inline-tabs - sphinx>=5.0 + - sphinx-remove-toctrees - sphinxext-opengraph - sphinxext-rediraffe - zarr>=2.10 - pip: - sphinxcontrib-mermaid - - sphinx-remove-toctrees # relative to this file. Needs to be editable to be accepted. - -e ../.. From 82630fc5dfc8865831ce0980791a20377ac82a25 Mon Sep 17 00:00:00 2001 From: Deepak Cherian Date: Wed, 28 Aug 2024 11:37:40 -0600 Subject: [PATCH 5/5] revert navigation_depth change --- doc/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/conf.py b/doc/conf.py index 899a5f9ec67..e418045207c 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -247,7 +247,7 @@ repository_url="https://github.com/pydata/xarray", repository_branch="main", navigation_with_keys=False, # pydata/pydata-sphinx-theme#1492 - navigation_depth=2, # speeds up the build + navigation_depth=4, path_to_docs="doc", use_edit_page_button=True, use_repository_button=True,