Biblioteca Python para criar aplicações CLI a partir de type hints padrão, com ajuda, validação e conclusão de comandos no shell automáticas.
20,3 mil+45 esta semana1 milPythonMITAtualizado há 11 horas
tox-dev/sphinx-autodoc-typehints
Uma extensão do Sphinx que transfere as anotações de tipo do Python para os campos de parâmetros e retorno do autodoc, com links e suporte a stubs.
- Estrelas
- 588
- Forks
- 115
- Issues abertas
- 0
- Último commit
- há 2 horas
O que é?
sphinx-autodoc-typehints é uma extensão para o autodoc do Sphinx que lê as anotações de tipo do código Python documentado e as insere nos campos de parâmetros e retorno da documentação gerada. Assim, os desenvolvedores declaram cada tipo uma única vez no código, sem precisar repeti-lo nas docstrings.
A extensão cria links de cada parte de um tipo para sua documentação e resolve nomes importados somente dentro de um bloco `if TYPE_CHECKING:` ou declarados em arquivos stub `.pyi`. Ela também documenta variantes de `@overload` e valores padrão, além de poder tipar docstrings nos estilos Google e NumPy, usadas com napoleon ou numpydoc.
A documentação do projeto compara a extensão com a configuração integrada `autodoc_typehints` do Sphinx e mostra diferenças como `**kwargs` tipados com `TypedDict`, descrições com `Annotated[..., Doc(...)]` e avisos de `@deprecated`.
Recursos principais
- 01Insere as anotações de tipo do código nos campos de parâmetros e retorno do autodoc.
- 02Cria links de cada parte de um tipo para sua documentação.
- 03Resolve nomes importados dentro de TYPE_CHECKING e declarados em stubs .pyi.
- 04Documenta variantes de @overload e valores padrão.
- 05Tipa argumentos nomeados de TypedDict por meio de **kwargs: Unpack[...].
- 06Dá suporte aos estilos de docstring Google, NumPy, napoleon e numpydoc.
Casos de uso
- Documentar uma biblioteca Python tipada com o autodoc do Sphinx.
- Exibir tipos de stubs .pyi para extensões C sem anotações.
- Manter a documentação da API sincronizada com as anotações de tipo, sem duplicá-las nas docstrings.
Início rápido
- 1
Instale a extensão pelo PyPI
pip install sphinx-autodoc-typehints - 2
Adicione a extensão ao conf.py depois de sphinx.ext.autodoc
Em coleções
Tópicos
Perguntas frequentes
- O que é sphinx-autodoc-typehints?
- Uma extensão do Sphinx que transfere as anotações de tipo do Python para os campos de parâmetros e retorno do autodoc, com links e suporte a stubs. sphinx-autodoc-typehints é uma extensão para o autodoc do Sphinx que lê as anotações de tipo do código Python documentado e as insere nos campos de parâmetros e retorno da documentação gerada. Assim, os desenvolvedores declaram cada tipo uma única vez no código, sem precisar repeti-lo nas docstrings.
- sphinx-autodoc-typehints é gratuito? Qual é a licença?
- sphinx-autodoc-typehints é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
- sphinx-autodoc-typehints ainda é mantido?
- Manutenção ativa. O último commit de sphinx-autodoc-typehints foi em 6 de nov. de 2026.
- Para que posso usar sphinx-autodoc-typehints?
- Documentar uma biblioteca Python tipada com o autodoc do Sphinx. Exibir tipos de stubs .pyi para extensões C sem anotações. Manter a documentação da API sincronizada com as anotações de tipo, sem duplicá-las nas docstrings.
- Como instalar sphinx-autodoc-typehints?
- Instale a extensão pelo PyPI: pip install sphinx-autodoc-typehints Adicione a extensão ao conf.py depois de sphinx.ext.autodoc
- Onde consigo sphinx-autodoc-typehints?
- O código-fonte e as instruções de instalação estão no GitHub: https://github.com/tox-dev/sphinx-autodoc-typehints
Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.
Projetos relacionados
Plugin do MkDocs que gera documentação de referência da API diretamente das docstrings do código-fonte, usando handlers específicos para cada linguagem.
2,1 mil+2 esta semana126PythonISCAtualizado há 14 dias
Gerador de documentação para Python que cria HTML, PDF, EPUB e outros formatos a partir de fontes em reStructuredText ou Markdown.
8,1 mil2,6 milPythonOtherAtualizado há 5 dias
Plugin do Sphinx que integra a documentação de API em C/C++ gerada pelo Doxygen a documentos em reStructuredText e Sphinx.
816215PythonOtherAtualizado há 5 dias
Ferramenta de linha de comando que monitora um diretório de documentação Sphinx, recompila os docs quando há alterações e atualiza o navegador por meio de um servidor local.
611100PythonMITAtualizado há 15 dias
Uma extensão do Sphinx que interpreta docstrings no estilo NumPy e as transforma em documentação de API estruturada.
354184PythonOtherAtualizado há 5 dias