aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorGravatar Hassan Abouelela <[email protected]>2022-05-29 23:07:05 +0400
committerGravatar Hassan Abouelela <[email protected]>2022-05-29 23:09:04 +0400
commit8bf56038efdbedca7e01316cc3a295b8c38986d8 (patch)
treec4ea93aa566546dab3c97486ea4364297fe27729 /docs
parentDelete CHANGELOG.md (diff)
Declare Releases As Parallel-Read Safe
Signed-off-by: Hassan Abouelela <[email protected]>
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 12431235..c4f24035 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -186,6 +186,16 @@ releases_github_path = REPO_LINK.removeprefix("https://github.com/")
releases_release_uri = f"{REPO_LINK}/releases/tag/v%s"
+def _releases_setup(app: Sphinx) -> dict:
+ """Wrap the default setup of releases to declare it as parallel-read safe."""
+ _original_releases_setup(app)
+ return {"parallel_read_safe": True}
+
+
+_original_releases_setup = releases.setup
+releases.setup = _releases_setup
+
+
# -- Options for the multiversion extension ----------------------------------
# Only include local refs, filter out older versions, and don't build branches other than main
# unless `BUILD_DOCS_FOR_HEAD` env variable is True.