Resultados da pesquisa a pedido "python-sphinx"
Link para método de classe em python docstring
Eu quero adicionar um link para um método na minha classe de dentro da doutrina de outro método da mesma classe. Quero que o link funcione na esfinge e, de preferência, também no Spyder e em outros IDEs do Python. Eu tentei várias opções e ...
Posso suprimir a expansão variável na documentação do Sphinx?
No meu código eu tenho X_DEFAULT = ['a', 'long', 'list', 'of', 'values', 'that', 'is', 'really', 'ugly', 'to', 'see', 'over', 'and', 'over', 'again', 'every', 'time', 'it', 'is', 'referred', 'to', 'in', 'the', 'documentation']e depois def ...
No Sphinx, existe uma maneira de documentar parâmetros e declará-los?
Prefiro documentar cada parâmetro (conforme necessário) na mesma linha em que declaro o parâmetro para aplicarSECO. [http://en.wikipedia.org/wiki/Don't_repeat_yourself] Se eu tiver um código como este: def foo( flab_nickers, # a series of under ...
Como fazer com que o Sphinx respeite a importação de classes no pacote com __init__.py
Eu tenho um pacote: foofoo.pybar.py__init__.pyfoo.py tem uma classe Foo. Em __init__.py, importo a classe Foo para que os usuários possam: from foo import FooSphinx corretamente documenta Foo como foo.foo.Foo, o que é certo, mas confuso para os ...
As importações relativas exigem o argumento 'package'
Eu quero usar o Sphinx para que ele possa gerar automaticamente um pydoc para o meu código python, mas estou recebendo um erro. O que estou fazendo de errado? conf.pyarquivo de configuração sphinx import sys import os from django.conf import ...
Como desabilito as cores na saída do LaTeX gerada a partir do sphinx?
Quando crio o arquivo LaTeX gerado a partir do sphinx, as entradas do sumário e os cabeçalhos da seção ficam azuis. Existe uma maneira fácil de desativar a coloração desses itens? Caso contrário, existe uma maneira fácil de torná-los pretos? Meu ...
Como eu faria referência cruzada com uma função gerada pelo autodoc no Sphinx?
Estou usando oEsfinge autodoc para gerar documentação com base nos documentos da minha biblioteca Python. A sintaxe para referência cruzada é encontradaaqui [http://sphinx-doc.org/markup/inline.html#ref-role] Uma etiqueta deve preceder a seção ...
Como adicionar um arquivo CSS personalizado ao Sphinx?
Como posso adicionar um arquivo css personalizado? A seguinte configuração não funciona para mim: # conf.py html_static_path = ['_static'] html_theme = 'default' html_theme_options = { 'cssfiles': ['_static/style.css'] ...
Substituição em Advertências
Como posso fazer uma substituição em uma advertência? Por exemplo: |p| account .. note:: **Been using |p| separately and now integrating?**No meu sphinx conf.py, defino uma regra de substituição que é anexada ao primeiro arquivo antes da ...
Qual é a relação entre docutils e Sphinx?
Parece haver uma infinidade de ferramentas de documentação para Python. Outro que eu encontrei é o epydoc. Parece que o Sphinx é o padrão de fato, porque é usado para gerar os documentos oficiais do Python. Alguém pode resolver o estado atual das ...