Resultados da pesquisa a pedido "python-sphinx"
O que significa "Nível de título inconsistente"?
Eu recebi avisos em minha documentação da variedade "Nível de título inconsistente". Tanto quanto posso dizer, tenho uma estrutura consistente que se parece com: Big Title ========= Section ------- Subsection ~~~~~~~~~~mas o erro está associado ...
Impedir o aninhamento de subseções no Python Sphinx ao usar toctree
Estou com um problema na estruturação do meu guia do usuário do Sphinx. Gostaria de formar um capítulo com uma página de entrada principal (index.rst) que contenha o cabeçalho do capítulo e uma visão geral, e depois separar as subseções contidas ...
Sphinx apidoc - não imprime o caminho completo para pacotes e módulos
Eu sou bastante novo no sphinx e estou tentando usá-lo como referência de API para o meu projeto. Talvez depois disso como documentação do projeto também. Eu o gero usando esses dois comandos sphinx-apidoc -e -o doc/api tracer sphinx-build -b ...
Como documentar pacotes Python usando o Sphinx
Estou tentando documentar um pacote em Python. No momento, tenho a seguinte estrutura de diretórios: . └── project ├── _build │ ├── doctrees │ └── html │ ├── _sources │ └── _static ├── conf.py ├── index.rst ├── __init__.py ├── make.bat ├── ...
Como omito os valores das variáveis no Sphinx?
Eu tenho algumas variáveis no nível do módulo que possuem valores longos e desinteressantes que eu gostaria de excluir da documentação gerada automaticamente. Existe uma maneira de fazer isso? Por exemplo, na minha fonte Python eu tenho algo ...
Ancorar em posição arbitrária com sphinx / reStructuredText?
É possível adicionar uma âncora (destino do link, ao qual posso me referir com:ref:) em uma posição arbitrária no texto? Eu tenho uma situação como esta: Some text .. class:: mylist **Term 1** Definition *Term 2* Definition :customrole:`Term 3` ...
O Sphinx autodoc não é automático o suficiente
Estou tentando usar o Sphinx para documentar um projeto de mais de 5.000 linhas em Python. Possui cerca de 7 módulos básicos. Tanto quanto eu sei, para usar o autodoc eu preciso escrever um código como este para cada arquivo no meu projeto: .. ...
Sphinx, mantendo a API atualizada
O esquema é o seguinte. Existe um pacote chamadofoo (uma API em desenvolvimento pesado, nas primeiras fases alfa) cujarst os arquivos são gerados automaticamente comsphinx-apidoc. Por uma questão de ter uma documentação melhor parafoo depois que ...
Como tenho várias versões do meu documento com esfinge?
Como a documentação de python ou django, como tenho várias versões do meu documento com sphinx? Salvei meu documento no git e quero que meu usuário possa ver a documentação de versões diferentes, comov2.7,v3.4etc Obrigado pela ajuda
Sphinx automodule funciona offline, mas não através do readthedocs.org
Eu não consigo fazer com que o ReadTheDocs mostre os módulos: any: members :, por exemplo, no meu html local, recebo: MODULE module.Beta(r, theta, beta) evaluates Beta at pointmas depois de pressionar para o github, o documento readthedocs diz ...