Repolode
Enviar
ml-tooling

ml-tooling/lazydocs

Herramienta de línea de comandos que genera documentación de API en Markdown a partir de docstrings de Python con formato Google, como alternativa más ligera a Sphinx.

Ver en GitHub
Estrellas
253
Forks
42
Issues abiertos
3
Último commit
hace 15 días

¿Qué es?

Lazydocs analiza un paquete de Python, un módulo o clases y funciones específicas, y luego escribe documentación en Markdown basada en sus docstrings con formato Google. Se puede ejecutar desde la línea de comandos con un solo comando o invocar desde Python mediante su API programática. De forma predeterminada, los archivos se guardan en la carpeta ./docs, aunque también se pueden imprimir en stdout.

Los archivos generados son compatibles con el renderizador Markdown de GitHub y se pueden incluir en un sitio de MkDocs. Se puede añadir a cada módulo, clase, método y función un enlace al archivo de código fuente y al número de línea, mediante rutas relativas o una URL base configurable. También se puede generar un archivo opcional de resumen que enumera todos los módulos, clases y funciones en un solo lugar.

La validación de docstrings mediante pydocstyle está disponible como comprobación opcional que detiene la generación si encuentra problemas. Otras opciones permiten controlar si se incluyen módulos privados, si se añaden una tabla de contenido y una marca de tiempo, y si la salida usa el formato md o mdx.

Funciones clave

  • 01Genera documentación de API en Markdown a partir de docstrings de Python con formato Google.
  • 02Crea enlaces al código fuente con las rutas de archivo y los números de línea.
  • 03Genera un archivo de resumen de la API que enumera módulos, clases y funciones.
  • 04Se integra con sitios de MkDocs y con Markdown renderizado por GitHub.
  • 05Valida opcionalmente los docstrings con pydocstyle antes de generar la documentación.

Casos de uso

  • Publicar páginas de referencia de la API de una biblioteca de Python junto a su repositorio de GitHub.
  • Añadir una sección de referencia de API generada automáticamente a un sitio de documentación de MkDocs.
  • Imprimir en la consola documentación basada en docstrings mientras se trabaja en un módulo.

Inicio rápido

  1. 1

    Instala lazydocs desde PyPI

    pip install lazydocs
  2. 2

    Genera documentación Markdown para tu paquete de Python

    lazydocs path/to/your/package

Antes de usarlo

  • Solo admite docstrings de Python con el estilo de Google.

En colecciones

Generadores de sitios estáticos y herramientas de documentación

Temas

#python#documentation#api-docs#markdown#docstring#mkdocs#google-style#api-docs-generator#pydoc#python-api

Preguntas frecuentes

¿Qué es lazydocs?
Herramienta de línea de comandos que genera documentación de API en Markdown a partir de docstrings de Python con formato Google, como alternativa más ligera a Sphinx. Lazydocs analiza un paquete de Python, un módulo o clases y funciones específicas, y luego escribe documentación en Markdown basada en sus docstrings con formato Google. Se puede ejecutar desde la línea de comandos con un solo comando o invocar desde Python mediante su API programática. De forma predeterminada, los archivos se guardan en la carpeta ./docs, aunque también se pueden imprimir en stdout.
¿lazydocs es gratuito? ¿Qué licencia tiene?
lazydocs es open source bajo la licencia MIT. Revisa los términos de la licencia antes de usarlo en productos comerciales.
¿lazydocs sigue mantenido?
Mantenimiento activo. El último commit de lazydocs fue el 23 oct 2026.
¿Para qué puedo usar lazydocs?
Publicar páginas de referencia de la API de una biblioteca de Python junto a su repositorio de GitHub. Añadir una sección de referencia de API generada automáticamente a un sitio de documentación de MkDocs. Imprimir en la consola documentación basada en docstrings mientras se trabaja en un módulo.
¿Cómo se instala lazydocs?
Instala lazydocs desde PyPI: pip install lazydocs Genera documentación Markdown para tu paquete de Python: lazydocs path/to/your/package
¿Dónde consigo lazydocs?
El código fuente y las instrucciones de instalación están en GitHub: https://github.com/ml-tooling/lazydocs

Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.

Proyectos relacionados