python-sphinx
Escribiendo docstrings usando autodoc

C++ CSS Django Flask Git HTML JavaScript latex MATLAB Language Python Language
Buscar..


Introducción

Sphinx permite la inclusión de documentstrings en la documentación utilizando la extensión autodoc que se envía con el paquete. Esta documentación le mostrará cómo formatear sus documentos y cómo incluirlos en su documentación.

Instalación de la extensión autodoc

Agregue el módulo autodoc en la list extensions presente en el archivo conf.py en la raíz de su documentación: 

extensions = [
    'sphinx.ext.autodoc',
     ...
]

Agregando su ruta de código en la configuración de la esfinge

Autodoc necesita importar tus módulos para trabajar.

Puede incluir su ruta de código en su archivo conf.py

Por ejemplo: 

import os
sys.path.insert(0, os.path.abspath('../src'))


Modified text is an extract of the original Stack Overflow Documentation
Licenciado bajo CC BY-SA 3.0
No afiliado a Stack Overflow