sphinx-doc/sphinx

Autodoc should output generated rst

Open

#2.953 aberto em 13 de set. de 2016

Ver no GitHub
 (3 comments) (11 reactions) (0 assignees)Python (1.985 forks)batch import
extensions:autodochelp wantedtype:proposal

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

When using autodoc or autosummary, the generated rst is never saved as far as I can tell. So if you go to a page that was generated with autosummary, like this: http://scikit-learn.org/dev/modules/generated/sklearn.cluster.DBSCAN.html#sklearn.cluster.DBSCAN

and you click "show this page's source" you'll just get the autosummary template: http://scikit-learn.org/dev/_sources/modules/generated/sklearn.cluster.DBSCAN.txt

That's not very helpful for debugging. I think storing the generated RST would be more helpful, possibly optionally?

Guia do colaborador

Direção de pesquisa
Investigue o mecanismo de saída das extensões autodoc/autosummary e determine onde o RST gerado pode ser capturado e gravado em arquivo.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Funcionalidade
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-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Python
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60