From 1dfe5bc29005f07b894555833b264d59311cd7f0 Mon Sep 17 00:00:00 2001 From: Jarry Shaw Date: Sat, 19 Sep 2026 20:48:39 -0400 Subject: [PATCH] docs: mark the Type Stubs copies of four TypedDicts :no-index: #520 made the `if SPHINX_TYPE_CHECKING:` TypedDicts importable during the build, which exposed that four of them are documented twice on the same page -- once under "Header Schemas" beside the option they belong to, and again in the "Type Stubs" appendix. Before #520 both occurrences failed to import, so nothing collided. - add `:no-index:` to the appendix copy of `RPLFlags`, `MPLFlags` and `DFFFlags` in `hopopt.rst` and `ipv6_opts.rst`, and of `Flags` in `tcp.rst`, keeping the inline "Header Schemas" occurrence canonical Measured with sphinx-build 9.1.0: 83 warnings -> 50, `duplicate object description` 36 -> 3, `failed to import` stays 0, no new warning appears. The 3 remaining duplicates pre-date #520 and are untouched. Also repairs cross references, which resolved to the appendix via `#id0` rather than to the canonical name anchor. --- docs/source/pcapkit/protocols/internet/hopopt.rst | 3 +++ docs/source/pcapkit/protocols/internet/ipv6_opts.rst | 3 +++ docs/source/pcapkit/protocols/transport/tcp.rst | 1 + 3 files changed, 7 insertions(+) diff --git a/docs/source/pcapkit/protocols/internet/hopopt.rst b/docs/source/pcapkit/protocols/internet/hopopt.rst index 3537a9cac..21f946a22 100644 --- a/docs/source/pcapkit/protocols/internet/hopopt.rst +++ b/docs/source/pcapkit/protocols/internet/hopopt.rst @@ -191,14 +191,17 @@ Type Stubs :show-inheritance: .. autoclass:: pcapkit.protocols.schema.internet.hopopt.RPLFlags + :no-index: :members: :show-inheritance: .. autoclass:: pcapkit.protocols.schema.internet.hopopt.MPLFlags + :no-index: :members: :show-inheritance: .. autoclass:: pcapkit.protocols.schema.internet.hopopt.DFFFlags + :no-index: :members: :show-inheritance: diff --git a/docs/source/pcapkit/protocols/internet/ipv6_opts.rst b/docs/source/pcapkit/protocols/internet/ipv6_opts.rst index 89d6bc776..6ff3f1dcf 100644 --- a/docs/source/pcapkit/protocols/internet/ipv6_opts.rst +++ b/docs/source/pcapkit/protocols/internet/ipv6_opts.rst @@ -191,14 +191,17 @@ Type Stubs :show-inheritance: .. autoclass:: pcapkit.protocols.schema.internet.ipv6_opts.RPLFlags + :no-index: :members: :show-inheritance: .. autoclass:: pcapkit.protocols.schema.internet.ipv6_opts.MPLFlags + :no-index: :members: :show-inheritance: .. autoclass:: pcapkit.protocols.schema.internet.ipv6_opts.DFFFlags + :no-index: :members: :show-inheritance: diff --git a/docs/source/pcapkit/protocols/transport/tcp.rst b/docs/source/pcapkit/protocols/transport/tcp.rst index 79903343a..a2dc3b522 100644 --- a/docs/source/pcapkit/protocols/transport/tcp.rst +++ b/docs/source/pcapkit/protocols/transport/tcp.rst @@ -307,6 +307,7 @@ Type Stubs :show-inheritance: .. autoclass:: pcapkit.protocols.schema.transport.tcp.Flags + :no-index: :members: :show-inheritance: