Articles of python esfinge

Sphinx Autodoc no es lo suficientemente automático

Estoy tratando de usar Sphinx para documentar un proyecto de más de 5,000 líneas en Python. Tiene unos 7 módulos de base. Que yo sepa, para usar autodoc necesito escribir código como este para cada archivo en mi proyecto: .. automodule:: mods.set.tests :members: :show-inheritance: Esto es demasiado tedioso porque tengo muchos archivos. Sería mucho más […]

Cómo conservar los saltos de línea al generar documentos de Python utilizando la esfinge

Estoy usando Sphinx para generar documentos para un proyecto de Python. La salida html no conserva los saltos de línea que están presentes en la cadena de documentación. Ejemplo: Código def testMethod(arg1,arg2): “”” This is a test method Arguments: arg1: arg1 description arg2: arg2 description Returns: None “”” print “I am a test method” Esfinge […]

Conectar Sphinx autodoc-skip-member a mi función

Quiero usar el evento autodoc-skip-member de sphinx para seleccionar una parte de los miembros en una determinada clase de Python para la documentación. Pero no está claro en los documentos de la esfinge, y no puedo encontrar ningún ejemplo que ilustre: ¿dónde coloco el código para conectar esto? Veo Sphinx.connect y sospecho que va en […]

¿Cómo usar el autodoc de Sphinx para documentar el método __init __ (auto) de una clase?

Sphinx no genera documentos para __init __ (auto) de forma predeterminada. He probado lo siguiente: .. automodule:: mymodule :members: y ..autoclass:: MyClass :members: En conf.py, configurar lo siguiente solo agrega la cadena de documentación __init __ (auto) a la cadena de documentación de la clase ( la documentación del autodoc de Sphinx parece estar de […]

Personaliza las plantillas para `sphinx-apidoc`

Recientemente he intentado usar sphinx-apidoc de Sphinx para ayudar a generar el texto reStructured específico de Sphinx desde la API de un proyecto Python. Sin embargo, el resultado que estoy obteniendo es: <img src="http://sofes.miximages.com/python/EVMje.png" alt="Aspecto predeterminado del resultado de sphinx-api “> ¿Alguien sabe si puedo personalizar la plantilla que utiliza sphinx-api para su salida? Específicamente, […]

¿Cómo puedo generar un valor de configuración en un archivo .rst de Sphinx?

Tengo lo siguiente en conf.py : def setup(app): app.add_config_value(‘base_url’,’http://localhost:2000′, True) ¿Cómo consigo esto en mis archivos .rst? Yo escribí esto: :base_url:/my_app/api/application/ Pero solo imprime :base_url: lugar de la URL real. ¿Cómo obtengo el valor de configuración real para ser emitido?

Cómo hacer que Sphinx respete la importación de clases en un paquete con __init__.py

Tengo un paquete foo foo.py bar.py __init__.py foo.py tiene una clase Foo. En __init__.py importo la clase Foo para que los usuarios puedan hacer: from foo import Foo Sphinx documenta correctamente a Foo como foo.foo.Foo, lo cual es correcto pero confuso para los usuarios. ¿Cómo consigo que Sphinx lo documente como foo.Foo? También es importante […]

¿Cómo documento las clases sin el nombre del módulo?

Estoy tratando de documentar un paquete de Python con sphinx y he generado con éxito archivos html. El paquete que estoy documentando consiste en un conjunto de archivos *.py , la mayoría de los cuales contiene una clase con un par de archivos que son módulos genuinos con funciones definidas. No necesito exponer el hecho […]

¿Puede la esfinge enlazar a documentos que no están ubicados en directorios debajo del documento raíz?

Estoy usando Sphinx para documentar un proyecto que no es Python. Quiero distribuir ./doc carpetas ./doc en cada submódulo, que contiene los archivos submodule_name.rst para documentar ese módulo. Luego quiero absorber esos archivos en la jerarquía maestra para crear una especificación para todo el diseño. Es decir: Project docs spec project_spec.rst conf.py modules module1 docs […]