Skip to content

Commit fd3bcfd

Browse files
authored
Exclude design docs from built documentation (#12628)
This PR excludes developer design docs from the Sphinx build while keeping the source files in the repository. ## Changes - Excluded `design/` directory from dev docs build via `exclude_patterns` - Removed `design/index` from dev documentation toctree - Design doc `.rst` files remain in `docs/dev/design/` directory for reference ## Next Steps Redirects will be configured in the RTD dashboard to point old design doc URLs to the corresponding GitHub source files. --- *Generated by Copilot*
1 parent 1292c9f commit fd3bcfd

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

docs/conf.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,9 @@
8484
version = "15.8.0"
8585
release = version
8686
exclude_patterns = ["_build", "shared", "_includes"]
87+
# Exclude design docs from dev documentation
88+
if docset == "dev":
89+
exclude_patterns.append("design")
8790
default_role = "obj"
8891
intersphinx_cache_limit = 14 # cache for 2 weeks
8992
intersphinx_timeout = 3 # 3 seconds timeout

docs/dev/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ or taking the open source Read the Docs codebase for your own custom installatio
1212
code-of-conduct
1313
issue-labels
1414
roadmap
15-
design/index
1615

1716
.. toctree::
1817
:caption: Development

0 commit comments

Comments
 (0)