Resultados de la búsqueda a petición "python-sphinx"
Incluya un archivo de texto * tal cual * en (Python) Sphinx Docs
(utilizando la herramienta de documentación Python-Sphinx) tengo un.txt archivo de registro que me gustaría incorporar_build/html inalterado. ¿Qué necesito alterar enconf.py, index.rstetc. Aquí está el diseño: src/ index.rst some_doc.rst ...
Personalizar plantillas para `sphinx-apidoc`
Recientemente he intentado usaresfinge-apidoc [http://sphinx-doc.org/man/sphinx-apidoc.html]deEsfinge [http://sphinx-doc.org/] para ayudar a generar texto reStructuredText específico de Sphinx desde la API de un proyecto de Python. Sin embargo, ...
Use el número de versión en los enlaces de archivo en Sphinx
En Sphinx, los enlaces de archivos se pueden generar utilizando la siguiente sintaxis: `name_of_file.js <some/location/name_of_file.js>`_En el archivo conf.py, unversion Se define una variable que podemos usar en los archivos .rst de ...
Cómo usar el módulo automático sphinx y las funciones expuestas en __init__
Tengo una estructura de carpetas que se parece a: 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 func1(): ...
¿Cómo escribir correctamente referencias cruzadas a documentación externa con Intersphinx?
Estoy tratando de agregar referencias cruzadas a API externas en mi documentación, pero me enfrento a tres comportamientos diferentes. Estoy usando sphinx (1.3.1) con Python (2.7.3) y mi mapeo intersphinx está configurado como: { 'python': ...
Esfinge: la etiqueta ivar busca referencias cruzadas
Quiero documentar los atributos del objeto Python con Sphinx. Entiendo que debería usar :ivar varname: description :ivar type varname: descriptionSin embargo, veo un comportamiento extraño, es decir, Sphinx busca en mi proyecto el nombre de ...
¿Cómo configuro estilos personalizados para reStructuredText, Sphinx, ReadTheDocs, etc.?
Quiero ampliar el tema utilizado porEsfinge yReadTheDocs con mis propios estilos personalizados ¿Cuál es la mejor manera en que puedo hacer esto para que mis cambios se mantengan?
No puedo usar Ref con una etiqueta usando Sphinx doc
Tengo un problema con el uso de la función Ref de Sphinx-doc, coloco una etiqueta sobre un párrafo y luego trato de vincularla desde otro documento pero dentro del mismo proyecto. La etiqueta que uso en un documento: .. _hal_1k_1p:Y la ...
Detener la esfinge de guiones
Tengo una pregunta similar aesta [https://tex.stackexchange.com/questions/5001/prevent-hyphenation-and-use-line-break-in-block-of-text] , a excepción de Sphinx y RST. Es decir, me gustaría evitar que el texto se separe al final de la línea. Por ...
Descargar HTML como páginas separadas
Estoy usando Read The Docs para un proyecto. Todo parece estar funcionando bien en línea. Sin embargo, cuando descargo el HTML para usarlo sin conexión, encuentro que la documentación está repleta en un solo archivo HTML (index.html). ¿Es posible ...