Preguntas etiquetadas con autodoc

Estoy tratando de usar Sphinx para documentar un proyecto de más de 5,000 líneas en Python. Tiene unos 7 módulos base. Hasta donde sé, para usar autodoc necesito escribir un código como este para cada archivo en mi proyecto: .. automodule:: mods.set.tests :members: :show-inheritance: Esto es demasiado tedioso porque tengo …

149 python  python-sphinx  autodoc 

Sphinx no genera documentos para __init __ (self) de forma predeterminada. He probado lo siguiente: .. automodule:: mymodule :members: y ..autoclass:: MyClass :members: En conf.py, estableciendo la siguiente sólo se añade la __init __ (self) docstring a la cadena de documentación de clase ( la documentación autodoc Esfinge parece estar …

107 python  python-sphinx  autodoc 

Estoy tratando de empezar con Sphinx y parece que tengo problemas implacables. Mando: docs/sphinx-quickstart Respondo todas las preguntas y todo funciona bien. Mando: docs/ls Todo parece normal. Resultado:build Makefile source Mando: sphinx-build -d build/doctrees source build/html Parece funcionar. Pude abrir el archivo index.html y ver un "shell" de lo que …

104 python  python-sphinx  autodoc 

Estoy usando sphinx y el complemento autodoc para generar documentación API para mis módulos de Python. Si bien puedo ver cómo documentar bien parámetros específicos, no puedo encontrar un ejemplo de cómo documentar un **kwargsparámetro. ¿Alguien tiene un buen ejemplo de una forma clara de documentarlos?

99 python  python-sphinx  autodoc