sphinx-doc/sphinx

Javascript domain :js:module:: [name] does not produce an entry in the module index

Open

#5517 aperta il 8 ott 2018

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Python (1985 fork)batch import
awaiting:responsedomains:jshelp wanted

Metriche repository

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

Descrizione

Problem

A .. :js:module:: [any module name] does not produce a module entry in the module index. But the documentation says it would make an entry. If you don't use :py:module:: no modindex.html will be generated. The :synopsis option is not supported.

Environment info

  • OS: Debian Stretch
  • Python 2.7 and 3:
  • Sphinx version: 1.8.1

Guida contributor

Direzione di ricerca
Esamina l'implementazione del dominio JavaScript in Sphinx per capire perché le direttive 'js:module' non vengono aggiunte all'indice dei moduli.
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
PythonSphinx
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60