En el generador de documentos Sphinx, ¿puedo agregar un paquete completo (recursivamente) al índice?

Question

Quiero generar documentación para mi paquete. Cada archivo en el proyecto contiene una extensa documentación. ¿Hay alguna forma de agregar rápidamente todo mi proyecto al índice de documentación?

Me gustaría generar automáticamente cierta documentación para todo el proyecto con el menor trabajo posible. Empecé añadiendo lo siguiente a index.rst:

.. automodule:: mymodulename 
    :members: 

Todo lo que parece haber hecho es elenments de documentos en el archivo __init__.py (sólo una cadena de documentación) - ¿hay alguna manera de hacer que documentar todo lo demás? Estoy buscando agregar absolutamente todo lo que se define en mi paquete y tener cada clase, constante, función (etc.) en el paquete que se agrega al índice apropiado.

¿Se puede hacer esto?

Answer 1

Puede usar sphinx-apidoc.
Del official documentation: sphinx-apidoc es una herramienta para la generación automática de fuentes Sphinx que, utilizando la extensión autodoc, documentan un paquete completo al estilo de otras herramientas automáticas de documentación API.

Un ejemplo podría ser el uso (desde su directorio raíz del proyecto):

$ sphinx-apidoc . --full -o doc -H 'MyProject' -A 'MyName' -V '1.0' 

Un directorio doc se crea con todo listo en su interior.
También puede ajustar la configuración de su documentación editando el archivo conf.py autogenerado.

Otra información útil se puede encontrar en similar question posted here.