Bem-vindos

O que usuários dizem:

“ Graças a essa grande ferramenta faz programadores adorarem escrever documentação!#8220;

Sphinx é uma ferramenta que torna fácil criar documentação inteligente e bonita, escrito por Georg Brandl e licenciado sob licença BSD.

Originalmente criado para Python Documentação, e com excepcionais funcionalidades para documentar projetos de software em uma gama de linguagens. Claro que esse site também foi criado com fontes reStructuredText usando Sphinx! As seguintes funcionalidades são enfatizadas:

  • Formatos de Saída: HTML (incluindo Ajuda Windows HTML Help), LaTeX (para versões PDF), ePub, Texinfo, Páginas man, Texto Plano
  • Extensiva referência cruzada: marcação semântica automatizada, funções com links, classes, citações, termos, glossários e pedaços similares de informação
  • Estrutura Hierárquica: fácil definição de documento raiz, com ligações automáticas, acima e abaixo na estrutura
  • Índices Automáticos: índices gerais bem como especificidades de linguagem, índices módulos
  • Tratamento de Código Fonte: automação ênfase usando Pygments destaque
  • Extensões: teste automático de código snippets, inclusão de docstrings de módulos Python (API docs), e mais
  • Extensões de Contribuintes: mais de 50 extensões contribuições dos usuários no repositório secundário; muitos delaas instaláveis através de PyPI

Sphinx usa Projeto reStructuredText como linguagem marcada e muito dos seus pontos fortes, vem do poder e capacidade sem igual do reStructuredText em receber, passar e traduzir Projeto Docutils.

Documentação

Você também pode baixar as versões em PDF/EPUB do menu pop-up de documentação do ``Sphinx`` no canto inferior direito.

Exemplos

Links para documentação gerada com Sphinx podem ser encontrados na página Projetos usando Sphinx.

Para exemplos de como arquivos fonte Sphinx se parecem, use os links “Exibir Fonte” em todas páginas a partir dessa página de boas vindas.

Também pode haver interesse nesse ótimo tutorial em como criar e personalizar documentação usando Sphinx, escrito pelos desenvolvedores do matplotlib.

There is a translation team in Transifex of this documentation, thanks to the Sphinx document translators.

Um livro em japonês sobre o ``Sphinx`` foi publicado pela O'Reilly: Sphinxをはじめよう / Learning Sphinx.

In 2019 the second edition of a German book about Sphinx was published: Software-Dokumentation mit Sphinx.

Hospedagem

Necessita de um local para armazenar seus documentos Sphinx? readthedocs.org já armazena diversos documentos Sphinx e integra-se bem com controle de fontes. Também tem funcionalidades nativas de busca que são mais abrangentes que mecanismo offline Sphinx JavaScript.

Guia para Contribuir

Se desejar contribuir com o projeto, essa parte da documentação é para você.

Code of Conduct

Please adhere to our Code of Conduct.