Repolode
Enviar
pdoc3

pdoc3/pdoc

Genera automáticamente documentación de API para proyectos de Python 3 a partir de módulos, paquetes y docstrings, sin configuración especial.

Ver en GitHubSitio web
Estrellas
1,187
Forks
146
Issues abiertos
111
Último commit
hace 3 meses

¿Qué es?

pdoc es una herramienta de línea de comandos que genera documentación HTML de API para proyectos de Python. Indícale un archivo de módulo, el directorio de un paquete o una ruta de importación, y genera páginas con los objetos públicos, sus docstrings y sus anotaciones de tipos.

Funciona con estilos habituales de docstrings, como Markdown, numpydoc y el estilo de Google; admite fórmulas matemáticas en LaTeX y algunas directivas reST, y respeta __all__ cuando está definido. Si no se especifican, hereda los docstrings de los miembros de una clase que se sobrescriben, y documenta las variables de módulo, clase e instancia recorriendo el AST. Además, enlaza automáticamente los identificadores entre sí.

Puedes personalizar la salida mediante plantillas y sobrescribir los docstrings con un diccionario __pdoc__ a nivel de módulo. Incluye un servidor web de desarrollo para previsualizar la documentación generada mientras editas.

Funciones clave

  • 01Genera documentación HTML a partir de un módulo, el directorio de un paquete o una ruta de importación.
  • 02Admite docstrings en Markdown, numpydoc y el estilo de Google.
  • 03Procesa anotaciones de tipos de PEP 484 y PEP 526.
  • 04Hereda los docstrings de los miembros de clase sobrescritos.
  • 05Enlaza automáticamente los identificadores mencionados.
  • 06Permite usar plantillas personalizadas e incluye un servidor para previsualizar los cambios en vivo.

Casos de uso

  • Publicar la documentación de referencia de la API de una biblioteca de Python.
  • Generar documentación navegable para un paquete interno de Python sin configuración adicional.
  • Previsualizar cómo se renderizan los docstrings mientras redactas la documentación.

Inicio rápido

  1. 1

    Instala pdoc3 desde PyPI

    pip install pdoc3
  2. 2

    Genera la documentación de tu proyecto

    pdoc your_project

Antes de usarlo

  • El paquete de PyPI se llama pdoc3, no pdoc, así que debes instalarlo con ese nombre.
  • Se distribuye bajo la licencia AGPL-3.0, una licencia copyleft fuerte que puede restringir su uso en proyectos de código cerrado.

En colecciones

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

Temas

#python#api-documentation#documentation-generator#docstring#docs#docs-generator#docstring-documentation#docstrings#documentation#documentation-dumper

Preguntas frecuentes

¿Qué es pdoc?
Genera automáticamente documentación de API para proyectos de Python 3 a partir de módulos, paquetes y docstrings, sin configuración especial. pdoc es una herramienta de línea de comandos que genera documentación HTML de API para proyectos de Python. Indícale un archivo de módulo, el directorio de un paquete o una ruta de importación, y genera páginas con los objetos públicos, sus docstrings y sus anotaciones de tipos.
¿pdoc es gratuito? ¿Qué licencia tiene?
pdoc es open source bajo la licencia AGPL-3.0. Revisa los términos de la licencia antes de usarlo en productos comerciales.
¿pdoc sigue mantenido?
Actualizado en los últimos 6 meses. El último commit de pdoc fue el 15 ago 2026.
¿Para qué puedo usar pdoc?
Publicar la documentación de referencia de la API de una biblioteca de Python. Generar documentación navegable para un paquete interno de Python sin configuración adicional. Previsualizar cómo se renderizan los docstrings mientras redactas la documentación.
¿Cómo se instala pdoc?
Instala pdoc3 desde PyPI: pip install pdoc3 Genera la documentación de tu proyecto: pdoc your_project
¿Dónde consigo pdoc?
El código fuente y las instrucciones de instalación están en GitHub: https://github.com/pdoc3/pdoc

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

Proyectos relacionados