Repository navigation
docs: the viewcode module index links a builtins page that is never generated #1863
Description
_modules/index.html lists builtins and links builtins.html, which does not exist.
The cause is the BufferID aliases (foundation/reassembly/data/ip.py:27, reassembly/data/tcp.py:27, traceflow/data/tcp.py:39). Each is a subscripted Tuple, and Tuple in pcapkit.utilities.compat is the builtin tuple on every Python the docs build on. So BufferID.__module__ == 'builtins', and viewcode records the module. Sphinx 9.1's collect_pages lists every recorded module in the index, including ones with no source.
Fix: a viewcode-follow-imported handler in conf.py that maps these aliases to their defining module (verified to remove the entry), or document them with .. data:: rather than autodata. Low priority.
Activity
JarryShaw commentedon Oct 16, 2026
Blocked until #1856 merges. That PR bumps sphinx-autodoc-typehints, which changes how signatures render, and it edits
docs/source/conf.py, which this fix also edits.JarryShaw commentedon Oct 17, 2026
Started on top of #1877, the PR for #1856, so the
conf.pyedits don't conflict. One worker is taking #1858–#1863 together, since every fix goes throughconf.py.docs(conf): fix class signatures, defaults, aenum names, table ids an…
docs(conf): fix class signatures, defaults, aenum names, table ids an…
docs(conf): fix class signatures, defaults, aenum names, table ids an…
docs(conf): fix class signatures, defaults, aenum names, table ids an…