sphinx-doc/sphinx

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

Open

#5 517 ouverte le 8 oct. 2018

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)Python (1 985 forks)batch import
awaiting:responsedomains:jshelp wanted

Métriques du dépôt

Stars
 (5 625 stars)
Métriques de merge PR
 (Merge moyen 10j 11h) (11 PRs mergées en 30 j)

Description

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

Guide contributeur

Direction de recherche
Examinez l'implémentation du domaine JavaScript dans Sphinx pour comprendre pourquoi les directives 'js:module' ne sont pas ajoutées à l'index des modules.
Stack technique
python
Domaine
documentation
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonSphinx
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60