Resultados de la búsqueda a petición "python-sphinx"
¿Cómo puedo generar documentación útil de las constantes de objetos de Python con Sphinx?
Tengo algunas 'constantes' en un módulo de Python (
¿Está OptionParser en conflicto con sphinx?
Estoy tratando de escribir una documentación para mi proyecto en sphinx y cada vez que sphinx encuentra OptionParser en mi módulo me da: sphinx-build: error: no such option: -b Pensé que era imposible, así que escribí un módulo simple para ...
Excluir módulo docstring en autodoc
Estoy tratando de usar autodoc en Sphinx para imprimir las cadenas de documentación de cada función en un módulo específico, pero excluir la cadena de docume...
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 ...
Parcar archivos .rst con directivas específicas de Sphinx mediante programación
Me gustaría poder analizar primero la esfinge basada en Python para su posterior procesamiento y verificación. Algo como import sphinx p = sphinx.parse("/path/to/file.rst") do_something_with(p) Parece que algo es posible en docutils usando ...
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 ...
Generación automática de documentación para todo el contenido del paquete Python
Estoy tratando de generar automáticamente la documentación básica para mi base de código usando Sphinx. Sin embargo, tengo dificultades para indicarle a Sphinx que escanee recursivamente mis archivos. Tengo una base de código Python con una ...
La esfinge ha reportado enlaces rotos.
Al crear la documentación html, ¿cómo obliga a la esfinge a informar o crear un error en los enlaces que no existen?Específicamente, tengo propiedades y méto...
Anulando el límite de nombre de campo predeterminado en sphinx / docutils
estoy usandoesfinge para generar documentación html para un proyecto. Hago un uso extensivo delistas de campo.Al generar html, cada par de etiqueta / valor s...