¿Qué es esta opción “generada” en la directiva de resumen automático de Sphinx?

Estoy usando sphinx api-doc y las extensiones de resumen automático para documentar una API para una biblioteca y realmente no puedo entender el propósito de la opción generated/ continuación:

 .. autosummary:: :nosignatures: :toctree: generated/ module.function_1 module.function_2 ... 

He visto que esto es la documentación de la esfinge, y en bibliotecas como pandas. Estoy usando toctree y mi API se genera automáticamente, pero no entiendo lo que se genera. No veo que se genere una carpeta llamada, y no sé cuál es la ventaja / el propósito de esto.

Gracias

La opción “generada” es el nombre del directorio de salida donde Sphinx coloca los archivos “stub” .rst generados automáticamente. No tiene que ser llamado “generado”; Puedes usar cualquier nombre.

Cuando la variable de configuración autosummary_generate se establece en True , Sphinx genera un archivo autosummary para cada entrada enumerada en autosummary directivas de autosummary . Por ejemplo, si está documentando un módulo con varias clases, esta característica se puede usar para colocar la documentación completa de cada clase en una página separada. La tabla de resumen automático contendrá enlaces a estas páginas.