Fix missing Sphinx API references - #26
Open
Gonghan-Princess wants to merge 1 commit into
Open
Conversation
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.
Fixes #24.
Strict Sphinx HTML and man-page builds currently emit 12 warnings, including unresolved API references. Document the three
NearestDictrounding constants so they have real targets, linkSortedDictto its external API documentation, and give the two custom pickle reducers docstrings that link to their own constructors.Document
OrderedDict.updateexplicitly with its valid signature and behavior. This replaces the malformed autodoc entry generated fromMutableMapping.updatewhile preserving the public method's anchor and documentation. Also set the documentation language to English instead ofNone.Validation:
sphinx-build -n -W --keep-going -b htmland-b mannow pass with Sphinx 9.1.0.Current Blue, flake8, and mypy checks expose pre-existing issues also reproduced in the untouched baseline. An additional link audit found six unchanged source-view backlinks unrelated to this issue. These are left outside this documentation fix.
AI assistance: OpenAI Codex helped reproduce the warnings, prepare the documentation changes, verify generated links, run checks, and draft this description.