Articles of python esfinge

Sphinx-doc: automodule: con importaciones simuladas

Estoy intentando usar sphinx-doc: automodule: junto con los módulos Mock-ed out según esta respuesta. Específicamente estoy usando Mock para las importaciones de módulos PyQt5 que no están disponibles en ReadTheDocs. Curiosamente, estoy descubriendo que cualquier clase que herede de la clase de un módulo Mock-ed no está incluida en la documentación resultante. Parece que sphinx-doc […]

Apidoc de Sphinx: no imprima la ruta completa a paquetes y módulos

Soy bastante nuevo en la esfinge y trato de usarla como referencia de API para mi proyecto. Quizás después de eso también como documentación del proyecto. Lo genero usando estos dos comandos. sphinx-apidoc -e -o doc/api tracer sphinx-build -b dirhtml doc/ build/doc/dirhtml Hay un problema que produce esta tabla de contenidos. – tracer package – […]

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 documentación del módulo. ¿Es posible? La razón es que estoy usando la cadena de documentación de los módulos para especificar las opciones de la línea de comandos (con la encantadora […]

Valores de Sphinx para atributos reportados como Ninguno

Cuando uso el autodoc de Sphinx para documentar una clase, los valores de los atributos siempre se informan, (como se indica aquí , bajo # 437) pero siempre como “= Ninguno” Attribute = None Some Documentation Lo incluyo como .. autoclass:: core.SomeClass :members: Y mi código parece class SomeClass(object): def __init__(self): self.attribute = “value” #: […]

¿Es posible anular el autodoc de Sphinx para funciones específicas?

Estoy usando el complemento autodoc de Sphinx para documentar automáticamente un conjunto de módulos. Tengo una función que acepta *args , y me gustaría anular la documentación para mostrar el estilo de funcname(arg1[, arg2[, …]]) ligeramente más agradable que utiliza la documentación de Python stdlib. ¿Es posible anular la salida de autodoc para una función […]

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, […]