chore: enable -W strict sphinx build gate [hold for lock bump]#176
Draft
markgeejw wants to merge 1 commit into
Draft
chore: enable -W strict sphinx build gate [hold for lock bump]#176markgeejw wants to merge 1 commit into
markgeejw wants to merge 1 commit into
Conversation
Promotes sphinx warnings to errors (--keep-going to still report all in one pass) so doc-link rot and docs/client-API drift fail the build. HOLD: do not merge until openprotein-docs's pixi.lock is bumped to an openprotein-python release containing the docstring fixes (PR #222) and ESMIF1Model. Verified clean against the client's develop branch; against the currently pinned 0.13.0 this gate fails on 13 pending warnings.
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
1 participant
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.
What
Turns the doc build strict:
sphinx-build -W --keep-going. Warnings become errors so doc-link rot and docs/client-API drift fail the build instead of silently shipping (e.g. an empty autodoc stub for a missing class).This must merge together with the
pixi.lockbump to anopenprotein-pythonrelease that contains:ESMIF1Model.Against the currently pinned 0.13.0,
-Wfails on 13 pending warnings (2listsignature failures, 3ESMIF1Modelimport, 4 docstring indentation, 5session.x?highlighting) — all already fixed on the client'sdevelop, just not on PyPI. Merging before the lock bump would break thedevelopbuild and its dev-site deploy.Verification
Built with
-Wagainst the client'sdevelop(editable install): clean except the two untracked WIP notebooks (binder.ipynb,membrane.ipynb) that don't exist in a clean CI checkout. So CI's-Wbuild will be green once the lock points at a release with #222 + ESMIF1Model.Merge sequence
openprotein-pythonrelease (with #222 + ESMIF1Model).pixi update openprotein-python+ commit pyproject + pixi.lock.