sphinx-doc/sphinx

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

Open

#5.517 aberto em 8 de out. de 2018

Ver no GitHub
 (1 comment) (0 reactions) (0 assignees)Python (1.985 forks)batch import
awaiting:responsedomains:jshelp wanted

Métricas do repositório

Stars
 (5.625 stars)
Métricas de merge de PR
 (Mesclagem média 10d 11h) (11 fundiu PRs em 30d)

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

Guia do colaborador

Direção de pesquisa
Examine a implementação do domínio JavaScript no Sphinx para entender por que as diretivas 'js:module' não são adicionadas ao índice de módulos.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PythonSphinx
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60