Repolode
Enviar
pdoc3

pdoc3/pdoc

Gera automaticamente documentação de API para projetos Python 3 a partir de módulos, pacotes e docstrings, sem configuração especial.

Ver no GitHubSite
Estrelas
1,187
Forks
146
Issues abertas
111
Último commit
há 3 meses

O que é?

pdoc é uma ferramenta de linha de comando que gera documentação HTML de API para projetos Python. Basta indicar um arquivo de módulo, um diretório de pacote ou um caminho de importação para renderizar os objetos públicos com suas docstrings e anotações de tipo.

A ferramenta funciona com estilos comuns de docstrings, incluindo Markdown, numpydoc e o estilo do Google, oferece suporte a fórmulas LaTeX e algumas diretivas reST e respeita __all__ quando definido. Docstrings de membros de classe sobrescritos são herdadas quando não são especificadas, e variáveis de módulo, classe e instância são documentadas por meio da análise da AST. Os identificadores são vinculados entre si automaticamente.

A saída pode ser personalizada com templates, e as docstrings podem ser sobrescritas usando um dicionário __pdoc__ no nível do módulo. Um servidor web de desenvolvimento integrado permite visualizar a documentação renderizada enquanto você edita.

Recursos principais

  • 01Gera documentação HTML a partir de um módulo, diretório de pacote ou caminho de importação.
  • 02Oferece suporte a docstrings em Markdown, numpydoc e no estilo do Google.
  • 03Lida com anotações de tipo PEP 484 e PEP 526.
  • 04Herda docstrings de membros de classe sobrescritos.
  • 05Cria automaticamente links entre identificadores referenciados.
  • 06Permite usar templates personalizados e um servidor integrado de pré-visualização ao vivo.

Casos de uso

  • Publicar a documentação de referência da API de uma biblioteca Python.
  • Gerar documentação navegável para um pacote Python interno, sem configuração adicional.
  • Pré-visualizar a renderização das docstrings durante a elaboração da documentação.

Início rápido

  1. 1

    Instale o pdoc3 pelo PyPI

    pip install pdoc3
  2. 2

    Gere a documentação do seu projeto

    pdoc your_project

Antes de usar

  • O pacote no PyPI se chama pdoc3, não pdoc; portanto, instale-o com esse nome.
  • Licenciado sob AGPL-3.0, uma licença copyleft forte que pode restringir o uso em projetos de código fechado.

Em coleções

Geradores de sites estáticos e ferramentas de documentação

Tópicos

#python#api-documentation#documentation-generator#docstring#docs#docs-generator#docstring-documentation#docstrings#documentation#documentation-dumper

Perguntas frequentes

O que é pdoc?
Gera automaticamente documentação de API para projetos Python 3 a partir de módulos, pacotes e docstrings, sem configuração especial. pdoc é uma ferramenta de linha de comando que gera documentação HTML de API para projetos Python. Basta indicar um arquivo de módulo, um diretório de pacote ou um caminho de importação para renderizar os objetos públicos com suas docstrings e anotações de tipo.
pdoc é gratuito? Qual é a licença?
pdoc é open source sob a licença AGPL-3.0. Confira os termos da licença antes de usá-lo em produtos comerciais.
pdoc ainda é mantido?
Atualizado nos últimos 6 meses. O último commit de pdoc foi em 15 de ago. de 2026.
Para que posso usar pdoc?
Publicar a documentação de referência da API de uma biblioteca Python. Gerar documentação navegável para um pacote Python interno, sem configuração adicional. Pré-visualizar a renderização das docstrings durante a elaboração da documentação.
Como instalar pdoc?
Instale o pdoc3 pelo PyPI: pip install pdoc3 Gere a documentação do seu projeto: pdoc your_project
Onde consigo pdoc?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/pdoc3/pdoc

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados