Repository navigation
ci: build the docs on PRs via Heart's docs-build.yml (cti-upkeep 3c) - #126
Merged
Merged
Conversation
… cloning in conf.py - .github/workflows/docs.yml: thin caller (package: autocti), mirroring PyAutoFit's - docs/conf.py: PyAutoLens-style path setup; no more cloning PyAutoFit/PyAutoArray from the old personal-account URLs at build time (needed pyprojroot, and would shadow the branch-matched deps CI installs) - docs/requirements.txt removed: Read the Docs installs .[docs] (.readthedocs.yaml) and no sibling keeps one; it pinned autonerves==2024.11.6.1 - docs/sphinx_warning_baseline.txt: 15 (local build with arcticpy; re-set from CI if it differs) Closes #125 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
PyAutoCTI's Sphinx docs are now built on every PR that touches them, through Heart's reusable
docs-build.yml(PyAutoLabs/PyAutoHeart#325). The check fails when the warning count rises abovedocs/sphinx_warning_baseline.txt. Until now nothing checked the docs before merge, which is howdocs/apidrifted to 53 dead entries (fixed in #124). Closes #125 (cti-upkeep 3c).API Changes
None. CI and docs configuration only.
Test Plan
conf.py, with arcticpy, warnings written via-was the workflow counts them: 15 lines, 0 failed importsdocs-build.yml@main; before that,autoctiis an unknown package)Full API Changes (for automation & release notes)
Added
.github/workflows/docs.yml: thin caller (package: autocti), same triggers as PyAutoFit's.docs/sphinx_warning_baseline.txt: 15.Changed
docs/conf.py: PyAutoLens-style path setup. It no longer clones PyAutoFit/PyAutoArray fromrhayes777/Jammy2211at build time; that neededpyprojrootand would shadow the branch-matched dependencies CI installs.Removed
docs/requirements.txt: Read the Docs installs.[docs]per.readthedocs.yaml, no sibling keeps one, and it pinnedautonerves==2024.11.6.1.Read the Docs:
.readthedocs.yaml(.[docs]+ arcticpy post_install) is unchanged. The RTD build on main gets checked after merge.Tier: glance. Merge mode: auto-merge on green if the Witness passes. Heart STALE at ship time, human-acknowledged.
🤖 Generated with Claude Code