Repository navigation
DM-56905: Adopt documenteer 2.5.0b5 and drop ExecutionPhase nitpick ignores - #605
Merged
Merged
Conversation
Documenteer 2.5.0b5 degrades autotypes enum-member references in builds that reuse pickled doctrees, so the workaround added for Periodic CI is no longer needed.
Documentation preview
Build |
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
Follow-up to #603. That PR worked around a Periodic CI
docs-linkcheckfailure by addingnitpick_ignoreentries for threeExecutionPhase.*targets, because documenteer 2.5.0b4 only degraded those enum-member references to plain text in builds that read the sources, not in builds that reuse pickled doctrees.Documenteer 2.5.0b5 fixes that upstream (lsst-sqre/documenteer#554, fixed by lsst-sqre/documenteer#555), so the workaround can go.
Changes
pyproject.toml/uv.lock: bump the docs pin fromdocumenteer[guide]==2.5.0b4to2.5.0b5. The lockfile change is limited to documenteer.docs/documenteer.toml: remove thenitpick_ignoreblock added in DM-56905: Fix Periodic CI docs-linkcheck nitpick failure #603.No changelog fragment: this only touches docs build configuration and the development lockfile.
Validation
nox -s docs docs-linkcheck(the Periodic CI sequence, with both sessions sharing one doctree cache) passes both sessions with the ignores removed.prek runpasses on the changed files.References