Repolode
Enviar
ml-tooling

ml-tooling/lazydocs

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.

Ver no GitHub
Estrelas
253
Forks
42
Issues abertas
3
Último commit
há 15 dias

O que é?

Lazydocs analisa um pacote ou módulo Python, ou classes e funções específicas, e gera documentação em Markdown com base nas docstrings no estilo Google. Pode ser executado pela linha de comando com um único comando ou chamado em Python pela API programática. Por padrão, os arquivos são gerados na pasta ./docs, mas também é possível imprimir a saída em stdout.

Os arquivos gerados funcionam no renderizador Markdown do GitHub e podem ser incluídos em um site MkDocs. Cada módulo, classe, método e função pode ter um link para o respectivo arquivo de origem e número da linha, usando caminhos relativos ou uma URL base configurável. Também é possível gerar um arquivo de visão geral opcional que lista todos os módulos, classes e funções em um só lugar.

A validação de docstrings com pydocstyle está disponível como uma verificação opcional que interrompe a geração se encontrar problemas. Outras opções controlam se módulos privados são incluídos, se um índice e uma marca d'água com data e hora são adicionados e se a saída usa o formato md ou mdx.

Recursos principais

  • 01Gera documentação de API em Markdown a partir de docstrings Python no estilo Google.
  • 02Cria links para o código-fonte com caminhos de arquivo e números de linha.
  • 03Gera um arquivo de visão geral da API com a lista de módulos, classes e funções.
  • 04Integra-se a sites MkDocs e ao Markdown renderizado pelo GitHub.
  • 05Opcionalmente, valida as docstrings com pydocstyle antes de gerar a documentação.

Casos de uso

  • Publicar páginas de referência da API de uma biblioteca Python junto ao repositório no GitHub.
  • Adicionar uma seção de referência da API gerada automaticamente a um site de documentação MkDocs.
  • Exibir no console a documentação baseada em docstrings enquanto se trabalha em um módulo.

Início rápido

  1. 1

    Instale o lazydocs pelo PyPI

    pip install lazydocs
  2. 2

    Gere a documentação em Markdown para seu pacote Python

    lazydocs path/to/your/package

Antes de usar

  • Compatível apenas com docstrings Python no estilo Google.

Em coleções

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

Tópicos

#python#documentation#api-docs#markdown#docstring#mkdocs#google-style#api-docs-generator#pydoc#python-api

Perguntas frequentes

O que é lazydocs?
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. Lazydocs analisa um pacote ou módulo Python, ou classes e funções específicas, e gera documentação em Markdown com base nas docstrings no estilo Google. Pode ser executado pela linha de comando com um único comando ou chamado em Python pela API programática. Por padrão, os arquivos são gerados na pasta ./docs, mas também é possível imprimir a saída em stdout.
lazydocs é gratuito? Qual é a licença?
lazydocs é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
lazydocs ainda é mantido?
Manutenção ativa. O último commit de lazydocs foi em 23 de out. de 2026.
Para que posso usar lazydocs?
Publicar páginas de referência da API de uma biblioteca Python junto ao repositório no GitHub. Adicionar uma seção de referência da API gerada automaticamente a um site de documentação MkDocs. Exibir no console a documentação baseada em docstrings enquanto se trabalha em um módulo.
Como instalar lazydocs?
Instale o lazydocs pelo PyPI: pip install lazydocs Gere a documentação em Markdown para seu pacote Python: lazydocs path/to/your/package
Onde consigo lazydocs?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/ml-tooling/lazydocs

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

Projetos relacionados