Resultados da pesquisa a pedido "python-sphinx"
Parsing reStructuredText em HTML
Estou criando uma estrutura na qual deixo que os desenvolvedores descrevam seus pacotes usando reStructuredText. Quero analisar esse reStructuredText em HTML para que eu possa mostrá-lo em uma GUI. Estou familiarizado com o excelente Sphinx, ...
O OptionParser está em conflito com a esfinge?
Estou tentando escrever uma documentação para o meu projeto no sphinx e sempre que o sphinx encontra o OptionParser no meu módulo, ele me dá: sphinx-build: error: no such option: -bEu pensei que era impossível, então escrevi um módulo simples ...
Como preservar quebras de linha ao gerar documentos python usando sphinx
Estou usando o Sphinx para gerar documentos para um projeto python. O html de saída não está preservando as quebras de linha presentes na doutrina. Exemplo Códig def testMethod(arg1,arg2): """ This is a test method Arguments: arg1: ...
sphinx.ext.autodoc: Mantendo nomes de constantes na assinatura
Estou usando o recurso autodoc do Sphinx para documentar minha AP Exemplo DEFAULT_OPTION = 'default' def do_something(msg, option=DEFAULT_OPTION): print msgA documentação gerada agora mostra a seguinte assinatura: do_something(msg, ...
Como usar o Python para gerar programaticamente parte da documentação do Sphinx
Estou usandoEsfing [http://sphinx.pocoo.org/index.html] para gerar a documentação para um projeto me Neste projeto, descrevo uma lista de comandos disponíveis em um yaml [http://yaml.org] arquivo que, uma vez carregado, resulta em um dicionário ...
Sphinx formatação de ponto flutuante
Estou usando o Sphinx para gerar documentação a partir do código. Alguém sabe se existe uma maneira de controlar a formatação de números de ponto flutuante gerados a partir de argumentos padrã Por exemplo, se eu tiver a seguinte função: def ...
utomódulo @sphinx: como referenciar classes no mesmo módul
Estou tentando usar a esfinge autodoc [http://sphinx.pocoo.org/ext/autodoc.html] extension e especificamente a diretiva automodule para gerar automaticamente a documentação para o aplicativo django em que estou trabalhando. O problema é que eu ...
Parar arquivos .rst com diretivas específicas do Sphinx programaticamente
Gostaria de poder analisar rst baseado em esfinge em Python para processamento e verificação adicionais. Algo como import sphinx p = sphinx.parse("/path/to/file.rst") do_something_with(p) Parece que algo é possível nos docutils usando o ...
Como adicionar espaço em branco extra entre o cabeçalho da seção e um parágrafo
Eu quero ter mais espaço entre o cabeçalho e o parágrafo e entre os parágrafos. Não quero que essa seja uma configuração global, mas quero usá-la onde e quando necessário. Aprecie todas as sugestões.
como mostrar atributos de instância no sphinx do
Existe alguma maneira de mostrar automaticamente variáveis var1 e var2 e seus valores init na documentação do sphin class MyClass: """ Description for class """ def __init__(self, par1, par2): self.var1 = par1 * 2 self.var2 = par2 * 2 def ...