sphinx-doc/sphinx

Toctree `numbered` option doesn't create <ol> element

Open

#7934 aperta il 10 lug 2020

Vedi su GitHub
 (15 commenti) (1 reazione) (0 assegnatari)Python (1985 fork)batch import
builder:htmlhelp wantedinternals:toctreetype:proposal

Metriche repository

Star
 (5625 star)
Metriche merge PR
 (Merge medio 10g 11h) (11 PR mergiate in 30 g)

Descrizione

Describe the bug When building HTML, the toctree numbered option doesn't create <ol> element but instead, keeps an <ul> and add a number to the title of the linked pages.

To Reproduce


.. toctree::
   :maxdepth: 1
   :numbered:

   page1.rst
   page2.rst

Gives

<ul>
<li class="toctree-l1"><a href="page1.html">1. My title</a></li>
<li class="toctree-l1"><a href="page2.html">2. My other title</a></li>
</ul>

That also creates styling problems like have a bullet in front of numbers.

Expected behavior

Semantically, wouldn't it be better to get:

<ol>
<li class="toctree-l1"><a href="page1.html">1. My title</a></li>
<li class="toctree-l1"><a href="page2.html">2. My other title</a></li>
</ol>

Environment info

  • OS: macos
  • Python version: 3.7.5
  • Sphinx version: 3.1.1

Guida contributor

Direzione di ricerca
Ispeziona il codice di rendering di toctree in sphinx.environment.collectors.toctree o nel writer HTML per cambiare <ul> in <ol> quando si utilizza l'opzione numbered.
Tech stack
python
Dominio
documentation
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Python
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75