Repository navigation
docs(conf): resolve the 36 ambiguous cross-references at their source - #1790
Merged
Merged
Conversation
- conf.py: resolve_builtins_exactly drops the fuzzy-search flag from an implicit reference to a builtin name, so `dict`, `type` and `set` in a type reach the Python docs instead of the registry members TCP.dict, Command.type and TCP.set (25 warnings). - conf.py: save/restore_enum_member_docstring undo napoleon's inline `type: description` split on enum members, which turned a URL's colon into a bogus Type field on 51 registry members (the 4 `http`/`Echo` warnings). - docs: 44 `.. data::`/`.. function::` directives repeated their module in the name and registered as `<module>.<module>.<name>`; they take the bare name now, with `:module:` where it differs. Two `:type:` options qualify `_AT` (the 7 TypeVar warnings). - tests: pin the hooks against real Sphinx nodes and napoleon, and the events and priorities setup() connects them at, behind a declared HAS_SPHINX gate, and the directive names textually. Docs build: 0 ambiguity warnings (was 36), no new warnings. Closes #1775
Owner
Author
|
Verdict: GOOD TO GO at |
This was referenced Oct 15, 2026
JarryShaw
added a commit
that referenced
this pull request
Oct 15, 2026
…1803) Entries: - add #1791 (breaking: pack() leaves its instance unchanged), #1778 (Protocol in protocol.__all__), #1781 (PortEnumField miss with a nameless proto), #1779 (vendor.ipx _path), #1780 (examples READMEs to Markdown, build leftovers) and #1790 (36 ambiguous cross-references) - fold #1776 into the RPL 0x23 entry and #1381 into the dump-schema one Accuracy: - the benchmark and legacy_smoke READMEs are README.md since #1780 - EngineBase stays out of __all__, as #1016 settled - the #575 peek calls get() only once the value resolves - the #647 and #764 entries point at #775/#860, under which nothing mints - the #861 entry names #869 and #874 for the EnumRegistry move Figures: - preamble: 685 citations, #340 to #1791 - process.rst pin: 298 entries; CHANGELOG.md regenerated Refs #1103
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.
Please follow the guide below
You will be asked some questions, please read them carefully and answer honestly
Put an
xinto all the boxes [ ] relevant to your pull request (like that [x])Use Preview tab to see how your pull request will actually look like
Searched for similar pull requests
Followed the coding style (
make pylint,make mypy,make isort)make testpasses, and a test case covers the change. Narrow runs only, listed below.Added a changelog entry under
docs/source/changelog/and regeneratedCHANGELOG.md, if the change is user-visible: N/A — centralised in docs(changelog): shared 1.5.0 changelog — long-lived, merges last (#610, #616, #617, #618, #620) #657What is the purpose of your pull request?
Tick the commit type your subject line carries.
fix— corrects a defectfeat— adds a featureperf— changes performance, not behaviourrefactor— changes neither behaviour nor performancetest— tests onlydocs— documentation onlyci— workflows or build toolingrelease— bumps the version or rolls up a distributionchore— anything elseSummary
The docs build gave 36 "more than one target found" warnings. They are fixed at their source; the build now has 0, with no new warnings of any kind (clean
-Ebuilds, compared by page, kind and reference).dict,type,set(25): Sphinx's fuzzy suffix search matched registry members such asTCP.dict. Adoctree-readhook inconf.pyremoves the fuzzy flag from implicit references to builtin names; explicit roles keep their search.http,Echo(4): napoleon split enum-member docstrings at a URL's colon into a fake Type field, on 51 members. A save/restore pair around napoleon (priorities 400/600) undoes that._AT,_IT,_BT,_DT(7): 44 hand-written directives repeated their module in the name. They take the bare name now, and links reach the right module's TypeVar.tests/project/test_docs_ambiguous_xrefs_1775_unit.pypins the hooks with real Sphinx nodes, the event wiring, and the directive names. The Sphinx-dependent tests skip in CI behind a declaredHAS_SPHINXgate. Each hook, wiring line and priority fails a test when mutated... module::" belongs indocumentation.rst, which chore: drop stale build leftovers and move the examples' READMEs to Markdown (#1773) #1780 is editing.Closes #1775