Genera automáticamente documentación de API para proyectos de Python 3 a partir de módulos, paquetes y docstrings, sin configuración especial.
1,2 mil146PythonAGPL-3.0Actualizado hace 3 meses
numpy/numpydoc
Una extensión de Sphinx que analiza docstrings al estilo NumPy y los convierte en documentación de API estructurada.
- Estrellas
- 354
- Forks
- 184
- Issues abiertos
- 135
- Último commit
- hace 6 días
¿Qué es?
numpydoc es una extensión de Sphinx para gestionar docstrings escritos con el formato de documentación de NumPy. Convierte secciones como Parameters, Returns, Raises y Examples en contenido de Sphinx con el formato adecuado, para que los proyectos de Python mantengan un estilo de docstrings uniforme en todo el código.
Además de analizar docstrings, la extensión incorpora directivas para describir código, como np:function y np-c:function, que permiten documentar funciones y APIs de C al estilo NumPy. La guía de docstrings de NumPy incluida en el proyecto explica cómo redactar docstrings compatibles con la extensión.
El paquete requiere Python 3.10 o posterior y Sphinx 6 o posterior.
Funciones clave
- 01Analiza secciones de docstrings al estilo NumPy, como Parameters, Returns y Raises.
- 02Incorpora las directivas np:function y np-c:function para documentar objetos de código.
- 03Se integra con Sphinx como una extensión estándar.
Casos de uso
- Generar documentación de referencia de la API para una biblioteca de Python que use docstrings al estilo NumPy.
- Documentar funciones de extensiones de C con las directivas np-c junto con las APIs de Python.
Antes de usarlo
- No se pudo identificar la licencia en los metadatos del repositorio. Comprueba el archivo LICENSE antes de reutilizar el proyecto.
En colecciones
Temas
Preguntas frecuentes
- ¿Qué es numpydoc?
- Una extensión de Sphinx que analiza docstrings al estilo NumPy y los convierte en documentación de API estructurada. numpydoc es una extensión de Sphinx para gestionar docstrings escritos con el formato de documentación de NumPy. Convierte secciones como Parameters, Returns, Raises y Examples en contenido de Sphinx con el formato adecuado, para que los proyectos de Python mantengan un estilo de docstrings uniforme en todo el código.
- ¿numpydoc es gratuito? ¿Qué licencia tiene?
- numpydoc es open source bajo la licencia Other. Revisa los términos de la licencia antes de usarlo en productos comerciales.
- ¿numpydoc sigue mantenido?
- Mantenimiento activo. El último commit de numpydoc fue el 1 nov 2026.
- ¿Para qué puedo usar numpydoc?
- Generar documentación de referencia de la API para una biblioteca de Python que use docstrings al estilo NumPy. Documentar funciones de extensiones de C con las directivas np-c junto con las APIs de Python.
- ¿Dónde consigo numpydoc?
- El código fuente y las instrucciones de instalación están en GitHub: https://github.com/numpy/numpydoc
Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.
Proyectos relacionados
CLI de Python que mide cuántas funciones, clases, métodos y módulos de una base de código tienen docstrings, con umbrales de aprobado o error aptos para CI.
678+1 esta semana58PythonMITActualizado hace 5 días
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.
25342PythonMITActualizado hace 15 días
Generador de documentación para Python que crea HTML, PDF, EPUB y otros formatos a partir de fuentes reStructuredText o Markdown.
8,1 mil2,6 milPythonOtherActualizado hace 5 días
Un plugin de Sphinx que integra en la documentación de reStructuredText y Sphinx las API de C/C++ generadas con Doxygen.
816215PythonOtherActualizado hace 6 días
Herramienta de línea de comandos que observa un directorio de documentación de Sphinx, la reconstruye cuando hay cambios y recarga el navegador mediante un servidor local.
611100PythonMITActualizado hace 15 días