You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs: link inventory-less package references through |name|_ substitutions #1936
The owner asked on #1928 for references to packages with no usable inventory (aenum, pcap, pcapfile, pyshark, and the dpkt/scapy/cryptography modules those inventories lack) to link to the project instead of rendering as plain literals. The suggested form is |name|_, with .. |name| replace:: ``name``` and .. name: . pcapkit/protocols/internet/esp.py:158anddocs/source/pcapkit/protocols/internet/esp.rst:166already use this form for|cryptography|`.
Plan:
Define each substitution and target once, in rst_epilog in docs/source/conf.py.
Use |pkg|_ for package- and module-level names.
Keep member-level names as literals, since every one of them would link to the same homepage.
Scope widened per the owner on #1928: also move the repo's other existing per-file substitution and target pairs into rst_epilog, such as |cryptography| in esp.py/esp.rst. Do this after a repo-wide grep for .. | definitions. #1929 has merged, so this issue now waits only on #1928.
Activity
JarryShaw commentedon Oct 19, 2026
Scope widened per the owner on #1928: also move the repo's other existing per-file substitution and target pairs into
rst_epilog, such as|cryptography|inesp.py/esp.rst. Do this after a repo-wide grep for.. |definitions. #1929 has merged, so this issue now waits only on #1928.docs: link inventory-less packages through rst_epilog substitutions (#…
docs(const): link aenum through the epilog in the apptype and option_…
docs: link bare pcap module mentions to the PyPCAP/pcap-ct note (#1948)
docs: link bare pcap module mentions to the PyPCAP/pcap-ct note (#1948)…