Sphinx¶

Crie documentação inteligente e bonita com facilidade

📝 Formatação rica de texto

Crie em reStructuredText ou MyST Markdown para criar documentos técnicos altamente estruturados, incluindo tabelas, blocos de código realçados, notações matemáticas e muito mais.

🔗 Referência cruzada poderosa

Crie referências cruzadas dentro do seu projeto e até mesmo entre diferentes projetos. Inclua referências a seções, figuras, tabelas, citações, glossários, objetos código e muito mais.

📚 Formatos versáteis de documentação

Gere documentação nos formatos preferidos do seu público, incluindo HTML, LaTeX (para PDF), ePub, Texinfo, e mais.

🎨 Suporte extensível a temas

Crie documentação visualmente atraente, com uma ampla escolha de temas HTML embutidos e de terceiros e a capacidade de personalizar ou criar novos temas.

🔌 Totalmente extensível

Adicione funcionalidade personalizada, por meio de mecanismos de extensão robustos com inúmeras extensões embutidas e de terceiros disponíveis para tarefas como criação de diagramas, teste de código e muito mais.

🛠️ Documentação automática de API

Gere documentação de API para Python, C++ e outros domínios de software, manualmente ou automaticamente a partir de docstrings, garantindo que a documentação do seu código permaneça atualizada com o mínimo de esforço.

🌍 Internacionalização (i18n)

Adicione traduções de documentação em vários idiomas para atingir um público global.

🌟 Suporte e comunidade ativa

Beneficie-se de uma comunidade ativa, com numerosos recursos, tutoriais, fóruns e exemplos.

Usado por:

Python¶

Linux Kernel¶

Projeto Jupyter¶

Veja abaixo como navegar na documentação do Sphinx.

Ver também

A tabela de conteúdo da documentação do Sphinx tem uma lista completa das páginas deste site.

Primeiros passos¶

Essas seções cobrem os conceitos básicos de introdução ao Sphinx, incluindo a criação e construção de sua própria documentação a partir do zero.

Guias de usuário¶

Estas seções cobrem vários tópicos no uso e extensão do Sphinx para vários casos de uso. Eles são um guia abrangente para usar o Sphinx em muitos contextos e pressupõem mais conhecimento do Sphinx. Se você é novo no Sphinx, recomendamos começar com Primeiros passos.

Guia comunitário¶

Sphinx é apoiado pela comunidade e aceita contribuições de qualquer pessoa. As seções abaixo devem ajudar você a começar a se juntar à comunidade Sphinx, além de contribuir.

Veja o Guia dos contribuidores do Sphinx se você quiser contribuir para o projeto.

Comunidade

Guia de referência¶

A documentação de referência é mais completa e programática por natureza, é uma coleção de informações que podem ser rapidamente referenciadas. Se você quiser documentação orientada a casos de uso, veja Primeiros passos ou Guias de usuário.

Referência