Resultados de la búsqueda a petición "python-sphinx"
Parsing reStructuredText en HTML
Estoy creando un marco en el que dejo que los desarrolladores describan su paquete usando reStructuredText. Quiero analizar ese texto reStructuredText en HTML para poder mostrarlo en una GUI. Estoy familiarizado con el excelente Sphinx, pero ...
¿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 ...
Cómo preservar los saltos de línea al generar documentos de Python usando sphinx
Estoy usando Sphinx para generar documentos para un proyecto de Python. El html de salida no conserva los saltos de línea que están presentes en la cadena de documentos. Ejemplo Códig def testMethod(arg1,arg2): """ This is a test method ...
Cómo usar Python para generar mediante programación parte de la documentación de Sphinx
Estoy usandoEsfing [http://sphinx.pocoo.org/index.html] para generar la documentación de un proyecto mío. n este proyecto, describo una lista de comandos disponibles en una yaml [http://yaml.org] archivo que, una vez cargado, da como resultado ...
sphinx.ext.autodoc: mantener los nombres de las constantes en la firma
Estoy usando la función de autodoc de Sphinx para documentar mi API. Ejemplo DEFAULT_OPTION = 'default' def do_something(msg, option=DEFAULT_OPTION): print msg La documentación generada ahora muestra la siguiente firma: do_something(msg, ...
Formateo de coma flotante de la esfinge
Estoy usando Sphinx para generar documentación a partir del código. ¿Alguien sabe si hay una manera de controlar el formato de los números de coma flotante generados a partir de argumentos predeterminados. Por ejemplo, si tengo la siguiente ...
sphinx automodule: ¿cómo hacer referencia a clases en el mismo módulo?
Estoy tratando de usar la esfinge autodoc [http://sphinx.pocoo.org/ext/autodoc.html] extension y específicamente la directiva automodule para generar automáticamente documentación para la aplicación django en la que estoy trabajando. El problema ...
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 ...
Cómo agregar espacios en blanco adicionales entre el encabezado de sección y un párrafo
Quiero tener más espacio entre el encabezado y el párrafo y entre los párrafos. No quiero que esto sea una configuración global, pero quiero usarlo donde y cuando sea necesario. Agradezco cualquier sugerencia.
¿cómo mostrar los atributos de instancia en sphinx doc?
¿Hay alguna forma de mostrar automáticamente las variables var1 y var2 y sus valores de inicio en la documentación de sphinx? class MyClass: """ Description for class """ def __init__(self, par1, par2): self.var1 = par1 * 2 self.var2 = par2 * 2 ...