📚 Documentación Automática para Python con pdoc#
¿Documentas tus proyectos Python? pdoc lo hace automático y sin configuración. ⚡
🔍 ¿Qué es pdoc?#
pdoc es una herramienta que genera documentación API automáticamente a partir de tus docstrings de Python. Sin configuración. Sin complejidad.
✨ Características principales#
- 📝 Markdown puro — documenta con Markdown nativo
- 🏷️ Type annotations — soporte completo para anotaciones de tipo
- 🔗 Cross-links automáticos — identifiers se enlazan automáticamente
- 🔄 Live-reload — servidor web integrado con recarga en vivo
- 🎨 Templates personalizables — adapta el HTML a tu estilo
- 📖 numpydoc y Google-style — entiende ambos estilos de docstrings
💻 Uso básico#
# Instalar
pip install pdoc
# Generar documentación
pdoc tu_modulo_python
# O apuntando a un archivo
pdoc ./mi_proyecto.py🆚 vs Sphinx#
pdoc es ideal para proyectos que necesitan documentación API simple y elegante. Para necesidades mucho más complejas, Sphinx sigue siendo la opción recomendada.
💡 Explicación en pocas palabras#
pdoc es una librería Python que genera automáticamente documentación API HTML a partir de los docstrings de tu código, siguiendo la jerarquía de módulos del proyecto. No requiere configuración, soporta anotaciones de tipo, crea cross-links entre identificadores y viene con un servidor web integrado con live-reloading — perfecto para documentar librerías Python sin overhead.
Más información en el link 👇
