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á 15 dias
breathe-doc/breathe
Plugin do Sphinx que integra a documentação de API em C/C++ gerada pelo Doxygen a documentos em reStructuredText e Sphinx.
- Estrelas
- 816
- Forks
- 215
- Issues abertas
- 220
- Último commit
- há 6 dias
O que é?
O Breathe faz a integração entre Doxygen e Sphinx. O Doxygen analisa o código-fonte e extrai um modelo detalhado de classes, funções e outros símbolos, enquanto o Sphinx gera documentação extensa e bem formatada. O Breathe lê a saída XML do Doxygen e a disponibiliza como diretivas do Sphinx, permitindo escrever e estilizar páginas de referência de API junto com conteúdo redigido manualmente no mesmo conjunto de documentação.
O plugin pode ser instalado pelo PyPI com pip e requer Python 3.9+, Sphinx 7.2+ e Doxygen 1.9.2+. A documentação inclui exemplos das diretivas disponíveis, e o repositório contém uma suíte de testes e um script de comparação para verificar a saída da documentação entre commits.
O projeto é mantido por um pequeno grupo de colaboradores e é usado por várias grandes bases de código open source, incluindo PyTorch, NumPy e Apache Arrow, para publicar suas referências de API em C e C++.
Recursos principais
- 01Renderiza a saída XML do Doxygen como diretivas do Sphinx para C, C++ e símbolos relacionados.
- 02Permite incluir páginas de referência de API junto com conteúdo em reStructuredText redigido manualmente.
- 03Pode ser instalado pelo PyPI com pip.
- 04Requer Python 3.9+, Sphinx 7.2+ e Doxygen 1.9.2+.
- 05Inclui uma suíte de testes e um script para comparar a saída da documentação entre commits.
Casos de uso
- Publicar a referência de API de uma biblioteca em C ou C++ junto com seu guia do usuário no Sphinx.
- Manter a documentação de API gerada a partir de comentários no código sincronizada com a documentação redigida manualmente.
- Documentar bases de código embarcado ou de sistemas que já usam Doxygen.
Início rápido
- 1
Instale o Breathe pelo PyPI
pip install breathe
Antes de usar
- É necessário instalar o Doxygen 1.9.2 ou posterior e o Sphinx 7.2 ou posterior separadamente.
- A licença não está claramente especificada nos metadados.
Em coleções
Tópicos
Perguntas frequentes
- O que é breathe?
- Plugin do Sphinx que integra a documentação de API em C/C++ gerada pelo Doxygen a documentos em reStructuredText e Sphinx. O Breathe faz a integração entre Doxygen e Sphinx. O Doxygen analisa o código-fonte e extrai um modelo detalhado de classes, funções e outros símbolos, enquanto o Sphinx gera documentação extensa e bem formatada. O Breathe lê a saída XML do Doxygen e a disponibiliza como diretivas do Sphinx, permitindo escrever e estilizar páginas de referência de API junto com conteúdo redigido manualmente no mesmo conjunto de documentação.
- breathe é gratuito? Qual é a licença?
- breathe é open source sob a licença Other. Confira os termos da licença antes de usá-lo em produtos comerciais.
- breathe ainda é mantido?
- Manutenção ativa. O último commit de breathe foi em 1 de nov. de 2026.
- Para que posso usar breathe?
- Publicar a referência de API de uma biblioteca em C ou C++ junto com seu guia do usuário no Sphinx. Manter a documentação de API gerada a partir de comentários no código sincronizada com a documentação redigida manualmente. Documentar bases de código embarcado ou de sistemas que já usam Doxygen.
- Como instalar breathe?
- Instale o Breathe pelo PyPI: pip install breathe
- Onde consigo breathe?
- O código-fonte e as instruções de instalação estão no GitHub: https://github.com/breathe-doc/breathe
Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.
Projetos relacionados
O Doxygen gera documentação a partir de código-fonte comentado e também pode criar diagramas de estrutura e dependências de código sem documentação.
6,6 mil+4 esta semana1,4 milC++GPL-2.0Bem mantidoAtualizado há 4 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
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 transfere as anotações de tipo do Python para os campos de parâmetros e retorno do autodoc, com links e suporte a stubs.
588115PythonMITBem mantidoAtualizado há 22 horas
Uma extensão do Sphinx que interpreta docstrings no estilo NumPy e as transforma em documentação de API estruturada.
354184PythonOtherAtualizado há 6 dias