Perguntas com a marcação «autodoc»

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: .. automodule:: mods.set.tests :members: :show-inheritance: Isso é …

149 python  python-sphinx  autodoc 

O Sphinx não gera documentos para __init __ (self) por padrão. Eu tentei o seguinte: .. automodule:: mymodule :members: e ..autoclass:: MyClass :members: Em conf.py, definir o seguinte apenas anexa a docstring __init __ (self) à docstring da classe ( a documentação do autodoc do Sphinx parece concordar que esse …

107 python  python-sphinx  autodoc 

Estou tentando começar com o Sphinx e pareço ter problemas implacáveis. Comando: docs/sphinx-quickstart Eu respondo todas as perguntas e tudo funciona bem. Comando: docs/ls Tudo parece normal. Resultado:build Makefile source Comando: sphinx-build -d build/doctrees source build/html Parece que funciona. Consegui abrir o arquivo index.html e ver uma "casca" do que …

104 python  python-sphinx  autodoc 

Estou usando o sphinx e o plug-in autodoc para gerar documentação de API para meus módulos Python. Embora eu possa ver como documentar bem parâmetros específicos, não consigo encontrar um exemplo de como documentar um **kwargsparâmetro. Alguém tem um bom exemplo de uma maneira clara de documentar isso?

99 python  python-sphinx  autodoc