Skip to content

Commit 93af904

Browse files
authored
[skip-ci] Speed up docs build by limiting toctrees (#9395)
* [skip-ci] Try speeding up docs build Following https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/performance.html * bump to 3.12 * [skip-ci] latest mamba * Use mamba * revert navigation_depth change
1 parent 41d50b0 commit 93af904

File tree

3 files changed

+8
-3
lines changed

3 files changed

+8
-3
lines changed

.readthedocs.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
version: 2
22

33
build:
4-
os: ubuntu-22.04
4+
os: ubuntu-lts-latest
55
tools:
6-
python: mambaforge-4.10
6+
python: mambaforge-latest
77
jobs:
88
post_checkout:
99
- (git --no-pager log --pretty="tformat:%s" -1 | grep -vqF "[skip-rtd]") || exit 183

ci/requirements/doc.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ channels:
44
- conda-forge
55
- nodefaults
66
dependencies:
7-
- python=3.10
7+
- python=3.12
88
- bottleneck
99
- cartopy
1010
- cfgrib
@@ -40,6 +40,7 @@ dependencies:
4040
- sphinx-design
4141
- sphinx-inline-tabs
4242
- sphinx>=5.0
43+
- sphinx-remove-toctrees
4344
- sphinxext-opengraph
4445
- sphinxext-rediraffe
4546
- zarr>=2.10

doc/conf.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@
8888
"sphinxext.rediraffe",
8989
"sphinx_design",
9090
"sphinx_inline_tabs",
91+
"sphinx_remove_toctrees",
9192
]
9293

9394

@@ -198,6 +199,8 @@
198199
# The master toctree document.
199200
master_doc = "index"
200201

202+
remove_from_toctrees = ["generated/*"]
203+
201204
# General information about the project.
202205
project = "xarray"
203206
copyright = f"2014-{datetime.datetime.now().year}, xarray Developers"
@@ -244,6 +247,7 @@
244247
repository_url="https://github.com/pydata/xarray",
245248
repository_branch="main",
246249
navigation_with_keys=False, # pydata/pydata-sphinx-theme#1492
250+
navigation_depth=4,
247251
path_to_docs="doc",
248252
use_edit_page_button=True,
249253
use_repository_button=True,

0 commit comments

Comments
 (0)