Resultados da pesquisa a pedido "python-sphinx"
Inclua um arquivo de texto * como está * no Sphinx Docs (Python)
(usando a ferramenta de documentação Python-Sphinx) eu tenho um.txt arquivo de log que eu gostaria de criar_build/html inalterado. O que eu preciso alterarconf.py, index.rst, etc. Aqui está o layout: src/ index.rst some_doc.rst ...
O documento sphinx napoleon pode funcionar retornando vários argumentos?
Estou tentando usar o estilo de código do Google para documentar uma função para a qual eu uso esfinge com a extensão napoleon para criar a documentação. A função é incomum, pois retorna dois argumentos. Não acho que Napoleão lide com isso. Se ...
Personalize modelos para `sphinx-apidoc`
Eu tentei recentementeesfinge-apidoc [http://sphinx-doc.org/man/sphinx-apidoc.html]deEsfinge [http://sphinx-doc.org/] para ajudar a gerar reStructuredText específico do Sphinx a partir da API de um projeto Python. No entanto, o resultado que ...
Como usar o módulo automático de esfinge e as funções expostas em __init__
Eu tenho uma estrutura de pastas que se parece com: project/ mymodule/ __init__.py m1.py m2.py sub1/ __init__.py s1.py s2.py mymod/__init__.py: """The __init__ docstr""" from m1 import * from m2 import *mymod/m1.py: """m1 doc str""" def ...
Use o número da versão nos links de arquivo no Sphinx
No Sphinx, os links de arquivos podem ser gerados usando a seguinte sintaxe: `name_of_file.js <some/location/name_of_file.js>`_No arquivo conf.py, umversion é definida como variável que podemos usar nos arquivos .rst como: |version|Não é ...
Como escrever corretamente referências cruzadas para documentação externa com interesfinge?
Estou tentando adicionar referências cruzadas à API externa na minha documentação, mas estou enfrentando três comportamentos diferentes. Estou usando sphinx (1.3.1) com Python (2.7.3) e meu mapeamento inter-esfinge está configurado como: { ...
A tag Sphinx: ivar procura referências cruzadas
Quero documentar os atributos do objeto Python com o Sphinx. Eu entendo que eu deveria usar :ivar varname: description :ivar type varname: descriptionNo entanto, estou vendo um comportamento estranho, ou seja, o Sphinx procura no meu projeto o ...
Como configuro estilos personalizados para reStructuredText, Sphinx, ReadTheDocs etc.?
Eu quero estender o tema usado porEsfinge eReadTheDocs com meus próprios estilos personalizados. Qual é a melhor maneira de fazer isso para que minhas alterações permaneçam?
Não é possível usar Ref com uma etiqueta usando o Sphinx doc
Eu tenho um problema com o uso da função Ref do Sphinx-doc, coloco um rótulo acima de um parágrafo e tento vincular esse rótulo a partir de outro documento, mas dentro do mesmo projeto. O rótulo que eu uso em um documento: .. _hal_1k_1p:E o Ref ...
Faça o download do HTML como páginas separadas
Estou usando o Read The Docs para um projeto. Tudo parece estar funcionando bem online. No entanto, quando faço o download do HTML para uso offline, percebo que toda a documentação está repleta de um único arquivo HTML (index.html). É possível ...