Repository navigation
docs: the root page renders each toctree twice, in the sidebar and inline #973
Description
On the root page only, each of index.rst's toctrees renders twice — once in
furo's global sidebar and once inline in the page body. Measured in a built tree:
index.html <div class="sidebar-tree"> ... API Reference
index.html <div class="toctree-wrapper ...> ... API Reference
pcapkit/index.html sidebar only
Pre-existing, not introduced by #972. None of the three toctrees in
docs/source/index.rst carries :hidden:, and a non-hidden toctree always renders
inline as well as feeding the sidebar. Before #972 both copies were unlabelled, so
the duplication was there but easy to miss; #972's captions label both, which is
what made it visible. Every non-root page shows one copy only.
Filing rather than folding into #972 because the fix is a navigation decision with a
real cost either way:
:hidden:on the three root toctrees removes the body copy and leaves the
captioned sidebar as the single index. Cheapest, and conventional for furo — but
the root page then has no inline contents list for a reader who scrolls rather
than using the sidebar.- Leave it. The body copy is the landing page's own index and arguably earns its
place; the sidebar is navigation furniture.
My recommendation is :hidden:, since the sidebar is present on that page too and
the root page already carries About, Module Structure, Engine Comparison,
Installation and Indices and tables as real content — the inline tree adds a
third index above all of it.
Surfaced while checking the owner's no-duplication condition on #719.
Activity
JarryShaw commentedon Oct 1, 2026
Blocked on #972, and the blocker is checkable:
The fix here adds
:hidden:to the three toctrees indocs/source/index.rst— thesame three #972 just captioned, at the same lines. Starting now would conflict with
a PR that is already reviewed and green rather than build on it.
Not waiting on a decision: the ruling on #719 was to follow my recommendations and
to avoid showing duplicated information, and this is the duplicated information,
with
:hidden:the recommendation. I am reading that as covering this issue — sayotherwise and I will hold it instead.
Unblocks the moment #972 merges.
JarryShaw commentedon Oct 1, 2026
Unblocked — #972 merged as
9285361e3(17:04:25Z) and is onmain:So the three captioned toctrees in
docs/source/index.rstthis issue adds:hidden:to now exist on
main.blockedremoved, work starting.docs(sphinx): hide the three root toctrees from the page body (#973) (#…