Repository navigation
docs: link inventory-less packages through rst_epilog substitutions (#1936) - #1939
Merged
Merged
Conversation
…1936) - Define every third-party project substitution and target once, in rst_epilog in docs/source/conf.py, and drop the per-page and per-docstring copies, which duplicated each other on assembled pages. - Write the aenum, cryptography, dpkt, emoji, pcapfile and pyshark package literals as |pkg|_ links in pages, docstrings and doc comments; engine, adapter, toolkit and requirement names, and names below a package, stay literals. - Keep pcap a literal: PyPCAP and pcap-ct both install it, so no one project page is its target. - Leave format_class as is: it names classes, which stay literals, and signatures do not expand substitutions. - Add a test pinning the epilog, the links and the absence of duplicates, and point the #1919 test's message at the |pkg|_ form. Closes #1936
Owner
Author
|
GOOD TO GO at |
4 of 5 tasks
This was referenced Oct 19, 2026
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.
Searched for similar pull requests
Followed the coding style (
make pylint,make mypy,make isort)make testpasses, and a test case covers the changeAdded a changelog entry — N/A — centralised in docs(changelog): shared 1.5.0 changelog — long-lived, merges last (#610, #616, #617, #618, #620) #657
docs— documentation onlyAs ruled on #1928, every third-party project substitution and link target is now defined once, in
rst_epilogindocs/source/conf.py. The per-page and per-docstring copies are removed. Package mentions ofaenum,cryptography,dpkt,emoji,pcapfileandpysharkare now|pkg|_links.Engine, adapter and toolkit names, requirement lists and member-level names stay literals.
pcapalso stays a literal, because both PyPCAP and pcap-ct install it, so no single project page fits.format_classis unchanged: it names classes, and signatures do not expand substitutions.The new
tests/project/test_docs_epilog_links_1936_unit.pypins the epilog, the links and the absence of duplicate definitions. It fails onmain. The pinned docs build reports 0 warnings.Closes #1936