Ejemplos¶

Sobre documentar desde docstrings¶

Hice varios ejemplos (6 en total) para descargar. Hay dos para cada forma de documentar explicada en la página de Recetas:

Receta simple: Se incluyen los docstrings directamente en index.rst, estos ejemplos no siguen la estructura de archivos recomendada.
- introduccion: Documenta solamente un módulo de ejemplo.
- magia: Tiene dos módulos.
Receta manual: Cada módulo está en una página separada que fue creada manualmente.
- batch_ffmpeg: Es un programa que no sigue la estructura de archivos recomendada.
- pynprcalc: Es una calculadora con varios módulos y que además tiene fórmulas matemáticas en la documentación.
Usando autosummary: Cada módulo está en una página separada generada automaticamente.
- batch_ffmpeg.
- pynprcalc.

Como ejemplo, se puede ver el código fuente de esta guía.

Nota

Al ver los .rst desde GitHub, es necesario apretar el botón Raw para verlos en texto plano.

También se puede ver la documentación generada por pydoctor siguiendo estas instrucciones.