Skip to content

fix(docs): keep stable release overrides above shared development content #134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vitormattos merged 1 commit into from
Nov 9, 2026
Merged

fix(docs): keep stable release overrides above shared development content #134

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions tests/test_shared_sources.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ def fixture(self, root: Path) -> None:
(root / "developer_manual/integration").mkdir(parents=True)
(root / "developer_manual/integration/index.rst").write_text("Architecture")
(root / "developer_manual/integration/new-guide.rst").write_text("New guide")
(root / "developer_manual/integration/_native-webhooks.inc").write_text(
"Development completion event"
)
(root / "developer_manual/api").mkdir()
(root / "developer_manual/api/openapi.rst").write_text("OpenAPI")
(root / "developer_manual/html").mkdir()
Expand Down Expand Up @@ -44,6 +47,8 @@ def test_new_rst_is_shared_without_editing_python(self):
(stable / "integration/_native-webhooks.inc").read_text(), "Only polling")
self.assertEqual(
(upcoming / "integration/_native-webhooks.inc").read_text(), "Native event")
self.assertEqual((dev / "integration/_native-webhooks.inc").read_text(),
"Development completion event")
self.assertFalse((stable / "integration/source-only.rst").exists())

def test_unlisted_development_section_is_not_leaked(self):
Expand Down
6 changes: 3 additions & 3 deletions versioning/build.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,11 @@ def source_tree(stage: Path, slug: str, manual: str) -> Path:
if slug == "main":
shutil.copytree(ROOT / manual, target)
else:
shutil.copytree(ROOT / "versioned/base" / manual, target)
# Contributors declare version-safe sections in versioned/shared.json.
# Copy them before release overlays; no Python change for new RST pages.
target.mkdir(parents=True, exist_ok=True)
# Stable base documentation takes precedence over shared sections.
for relative, source in shared_sources(manual):
shutil.copytree(source, target / relative, dirs_exist_ok=True)
shutil.copytree(ROOT / "versioned/base" / manual, target, dirs_exist_ok=True)
overlay = ROOT / "versioned" / slug / manual
if overlay.exists():
shutil.copytree(overlay, target, dirs_exist_ok=True)
Expand Down
Loading