Fix strict Sphinx documentation builds - #137
Open
ryanchou1994 wants to merge 1 commit into
Open
Conversation
Keep handler descriptions in one location, resolve Python type links, and check HTML and man output in CI.
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.
Strict Sphinx builds currently report duplicate module/handler descriptions, invalid language/static-path settings, and unresolved standard-library type references. This keeps the handler descriptions on the customization page and links to them from the API page, fixes the configuration, and resolves standard-library references through Python's documentation inventory. The dump annotation now spells out os.PathLike so its deferred annotation can be linked correctly.
The HTML and man builds run with -n -W in the Python 3.13 CI job. Both builds pass without warnings on macOS and Linux with Sphinx 9.1.0, compared with 24 warnings before the change. All 67 existing tests/doctests and mypy also pass on both platforms. The package builds successfully.
The handler anchors remain on handlers.html. Removing their duplicate descriptions from api.html removes those nine duplicate page-specific anchors; the API overview links directly to the canonical descriptions. The existing index.html#module-frontmatter anchor is preserved.
Fixes #94
Fixes #104