Skip to content

Commit

Permalink
Documented dependency on class "toctree-l1" in response to review <#1…
Browse files Browse the repository at this point in the history
  • Loading branch information
rptb1 committed Oct 20, 2023
1 parent 5d27364 commit 6fd0a91
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion manual/source/_templates/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,15 @@

<ul>

<li class="toctree-11">
{# The class toctree-l1 seems to correspond to list items generated
by a Sphinx toctree directive that are at depth 1. I have not
found documented confirmation of this but it is confirmed
`_toctree_add_classes
<https://github.com/sphinx-doc/sphinx/blob/bb74aec2b6aa1179868d83134013450c9ff9d4d6/sphinx/environment/adapters/toctree.py#L403-L430>`_
in the Sphinx source code. If the list layout goes wonky, this
might be to blame. RB 2023-10-20. #}

<li class="toctree-l1">

<a class="reference internal" href="{{pathto('genindex.html', 1)}}">Index</a>

Expand Down

0 comments on commit 6fd0a91

Please sign in to comment.