Biblioteca de Python para crear aplicaciones CLI a partir de anotaciones de tipos estándar, con ayuda, validación y autocompletado de shell automáticos.
20,3 mil+45 esta semana1 milPythonMITActualizado hace 18 horas
tox-dev/sphinx-autodoc-typehints
Una extensión de Sphinx que incorpora las anotaciones de tipos de Python a los campos de parámetros y valores de retorno de autodoc, con enlaces y compatibilidad con stubs.
- Estrellas
- 588
- Forks
- 115
- Issues abiertos
- 0
- Último commit
- hace 9 horas
¿Qué es?
sphinx-autodoc-typehints es una extensión para autodoc de Sphinx que lee las anotaciones de tipos del código Python documentado y las añade a los campos de parámetros y valores de retorno de la documentación generada. Así, los desarrolladores indican cada tipo una sola vez en el código, en lugar de repetirlo en las docstrings.
La extensión enlaza cada parte de un tipo con su documentación y resuelve nombres importados únicamente dentro de un bloque `if TYPE_CHECKING:` o declarados en archivos stub `.pyi`. También documenta las variantes de `@overload` y los valores predeterminados, y puede tipar docstrings con estilo Google y NumPy, escritos para napoleon o numpydoc.
La documentación del proyecto lo compara con la opción integrada `autodoc_typehints` de Sphinx y muestra diferencias como los `**kwargs` tipados con `TypedDict`, las descripciones `Annotated[..., Doc(...)]` y los avisos `@deprecated`.
Funciones clave
- 01Incorpora las anotaciones de tipos del código a los campos de parámetros y valores de retorno de autodoc.
- 02Enlaza cada parte de un tipo con su documentación.
- 03Resuelve nombres importados dentro de bloques TYPE_CHECKING y declarados en stubs .pyi.
- 04Documenta las variantes de @overload y los valores predeterminados.
- 05Tipa argumentos con nombre mediante **kwargs: Unpack[...] a partir de TypedDict.
- 06Admite docstrings con los estilos Google y NumPy, y con napoleon y numpydoc.
Casos de uso
- Documentar una biblioteca de Python con tipos mediante Sphinx autodoc.
- Mostrar los tipos de stubs .pyi para extensiones de C sin anotaciones.
- Mantener la documentación de la API sincronizada con las anotaciones de tipos, sin duplicarlas en las docstrings.
Inicio rápido
- 1
Instala la extensión desde PyPI
pip install sphinx-autodoc-typehints - 2
Añade la extensión a conf.py después de sphinx.ext.autodoc
En colecciones
Temas
Preguntas frecuentes
- ¿Qué es sphinx-autodoc-typehints?
- Una extensión de Sphinx que incorpora las anotaciones de tipos de Python a los campos de parámetros y valores de retorno de autodoc, con enlaces y compatibilidad con stubs. sphinx-autodoc-typehints es una extensión para autodoc de Sphinx que lee las anotaciones de tipos del código Python documentado y las añade a los campos de parámetros y valores de retorno de la documentación generada. Así, los desarrolladores indican cada tipo una sola vez en el código, en lugar de repetirlo en las docstrings.
- ¿sphinx-autodoc-typehints es gratuito? ¿Qué licencia tiene?
- sphinx-autodoc-typehints es open source bajo la licencia MIT. Revisa los términos de la licencia antes de usarlo en productos comerciales.
- ¿sphinx-autodoc-typehints sigue mantenido?
- Mantenimiento activo. El último commit de sphinx-autodoc-typehints fue el 6 nov 2026.
- ¿Para qué puedo usar sphinx-autodoc-typehints?
- Documentar una biblioteca de Python con tipos mediante Sphinx autodoc. Mostrar los tipos de stubs .pyi para extensiones de C sin anotaciones. Mantener la documentación de la API sincronizada con las anotaciones de tipos, sin duplicarlas en las docstrings.
- ¿Cómo se instala sphinx-autodoc-typehints?
- Instala la extensión desde PyPI: pip install sphinx-autodoc-typehints Añade la extensión a conf.py después de sphinx.ext.autodoc
- ¿Dónde consigo sphinx-autodoc-typehints?
- El código fuente y las instrucciones de instalación están en GitHub: https://github.com/tox-dev/sphinx-autodoc-typehints
Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.
Proyectos relacionados
Plugin de MkDocs que genera documentación de referencia de API directamente a partir de los docstrings del código fuente mediante handlers específicos para cada lenguaje.
2,1 mil+2 esta semana126PythonISCActualizado 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
Una extensión de Sphinx que analiza docstrings al estilo NumPy y los convierte en documentación de API estructurada.
354184PythonOtherActualizado hace 6 días