Sphinx é uma ferramenta que torna mais fácil para criar documentação inteligente e bonita para projetos Python (ou outros documentos que consistem em múltiplas fontes ReStructuredText), escrito por Georg Brandl. O projeto foi originalmente criado para traduzir a nova documentação Python, mas agora foi limpa na esperança de que ele vai ser útil para muitos outros projetos.
Sphinx usa reStructuredText como sua linguagem de marcação, e muitos de seus pontos fortes vêm do poder e simplicidade de reStruturedText e sua análise e tradução de suite, os Docutils.
Embora ainda está em constante desenvolvimento, os seguintes recursos já estão presentes, trabalham muito bem e pode ser visto "em ação" nos docs Python:
& Nbsp; * Os formatos de saída: HTML (incluindo o Windows Ajuda HTML) e LaTeX, para versões em PDF para impressão
& Nbsp; * referências cruzadas extensivas: marcação semântica e ligações automáticas para funções, classes, os termos do glossário e informações semelhantes
& Nbsp; * Estrutura hierárquica: fácil definição de uma árvore de documentos, com ligações automáticas aos irmãos, pais e filhos
& Nbsp; * índices automáticas: índice geral, bem como um índice de módulo
& Nbsp; * Manipulação Código: realce automático usando o marcador pygments
& Nbsp; * Várias extensões estão disponíveis, por exemplo, . para o teste automático de trechos e inclusão de docstrings adequadamente formatados
Requisitos :
- Python
Comentários não encontrado