Gera automaticamente documentação de API para projetos Python 3 a partir de módulos, pacotes e docstrings, sem configuração especial.
1,2 mil146PythonAGPL-3.0Atualizado há 3 meses
numpy/numpydoc
Uma extensão do Sphinx que interpreta docstrings no estilo NumPy e as transforma em documentação de API estruturada.
- Estrelas
- 354
- Forks
- 184
- Issues abertas
- 135
- Último commit
- há 6 dias
O que é?
numpydoc é uma extensão do Sphinx para lidar com docstrings escritas no formato de documentação do NumPy. Ela converte seções como Parameters, Returns, Raises e Examples em conteúdo formatado corretamente para o Sphinx, permitindo que projetos Python mantenham um estilo consistente de docstrings em toda a base de código.
Além de interpretar docstrings, a extensão adiciona diretivas para descrever código, como np:function e np-c:function, que documentam funções e APIs em C no estilo NumPy. O guia de docstrings do NumPy incluído no projeto explica como escrevê-las para que funcionem com a extensão.
O pacote requer Python 3.10 ou superior e Sphinx 6 ou superior.
Recursos principais
- 01Interpreta seções de docstrings no estilo NumPy, como Parameters, Returns e Raises.
- 02Adiciona as diretivas np:function e np-c:function para documentar objetos de código.
- 03Integra-se ao Sphinx como uma extensão padrão.
Casos de uso
- Gerar documentação de referência de API para uma biblioteca Python que usa docstrings no estilo NumPy.
- Documentar funções de extensões em C com as diretivas np-c, junto às APIs Python.
Antes de usar
- Não foi possível identificar a licença nos metadados do repositório. Confira o arquivo LICENSE antes de reutilizar o projeto.
Em coleções
Tópicos
Perguntas frequentes
- O que é numpydoc?
- Uma extensão do Sphinx que interpreta docstrings no estilo NumPy e as transforma em documentação de API estruturada. numpydoc é uma extensão do Sphinx para lidar com docstrings escritas no formato de documentação do NumPy. Ela converte seções como Parameters, Returns, Raises e Examples em conteúdo formatado corretamente para o Sphinx, permitindo que projetos Python mantenham um estilo consistente de docstrings em toda a base de código.
- numpydoc é gratuito? Qual é a licença?
- numpydoc é open source sob a licença Other. Confira os termos da licença antes de usá-lo em produtos comerciais.
- numpydoc ainda é mantido?
- Manutenção ativa. O último commit de numpydoc foi em 1 de nov. de 2026.
- Para que posso usar numpydoc?
- Gerar documentação de referência de API para uma biblioteca Python que usa docstrings no estilo NumPy. Documentar funções de extensões em C com as diretivas np-c, junto às APIs Python.
- Onde consigo numpydoc?
- O código-fonte e as instruções de instalação estão no GitHub: https://github.com/numpy/numpydoc
Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.
Projetos relacionados
Uma CLI para Python que mede quantas funções, classes, métodos e módulos de uma base de código têm docstrings, com limites de aprovação/reprovação adequados para CI.
678+1 esta semana58PythonMITAtualizado há 5 dias
Ferramenta de linha de comando que gera documentação de API em Markdown a partir de docstrings Python no estilo Google, como alternativa mais leve ao Sphinx.
25342PythonMITAtualizado há 16 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á 6 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á 6 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