Articles of python sphinx

¿Cuál es la relación entre docutils y Sphinx?

Parece que hay una gran cantidad de herramientas de documentación para Python. Otro que he encontrado es epydoc. Parece que Sphinx es el estándar de facto, porque se utiliza para generar los documentos oficiales de Python. ¿Alguien puede ordenar el estado actual de las herramientas de documentación de Python para mí?

Cómo especificar diferentes tipos de retorno en la cadena de documentación de Python

Actualmente estoy escribiendo documentación para mi paquete de Python usando Sphinx y el complemento autodoc. Para un valor de retorno de una función, por ejemplo, puedo escribir :returns: int: count que le dice a sphinx que hay un valor de retorno de tipo int, conteo llamado Ahora tengo una función que me permite predecesores de […]

Python: ¿Cómo puedo definir en la esfinge qué archivos y directorios .rst deben usarse?

¿Cómo puedo definir en la esfinge qué archivos y directorios .rst deben usarse? Quiero incluir un generador de documentación automático en mi script de prueba / construcción / documentación. sphinx-quickstart se ejecutó en mi área de trabajo y creó un archivo index.rst. Como sphinx utiliza archivos de texto reestructurados para la documentación, navegué por el […]

Usando la esfinge con Markdown en lugar de RST

Odio RST pero amo la esfinge. ¿Hay alguna forma en que la esfinge lea el margen de reducción en lugar de reStructuredText?

Sustitución de la variable Sphinx en bloques de código.

Usando Sphinx 1.2.3 y dado este fragmento de código RST: .. code-block:: xml |version| y en conf.py tengo: version = ‘1.0.2’ ¿Cómo se asegura de que el fragmento de código RST anterior se muestre como: 1.0.2 Esta pregunta anterior indica que debemos usar .. parsed-literal:: lugar de .. code-block:: , pero eso no funciona, ni […]

Finalizar bloque literal en el elemento de lista

Tengo un elemento de lista en mi primer archivo en el que me gustaría poner un bloque literal, pero no puedo hacer que el bloque literal finalice correctamente. Este es mi primer 1. Item 1 (not literal) 2. Item 2:: MyCode.example() Description of the code shown above (not literal) Me gustaría que el párrafo que […]

Python Sphinx hace referencia a nombres largos

Estoy trabajando en la documentación para mi módulo de Python (usando Sphinx y reST), y estoy descubriendo que al hacer referencias cruzadas con otros objetos de Python (módulos, clases, funciones, etc.) el nombre completo del objeto termina siendo increíblemente largo. A menudo es más de 80 caracteres, lo que me gustaría evitar a toda costa. […]

¿Cómo puedo documentar miembros en secciones específicas utilizando Sphinx?

Estoy luchando para averiguar cómo colocar la documentación para miembros específicos de mi clase de Python en secciones específicas de mi documentación de Sphinx, idealmente mientras se documenta automáticamente el rest en otra sección. Tengo una clase de python class MyClass(object): def funky(self, arg): “””Some docs.””” … definido en my/module.py que funciona como se esperaba […]

Sphinx elimina el formato de código de la referencia de código personalizado

Tengo las siguientes clases: class A: def x(): “”” Do the thing. “”” class B(A): def x(): “”” Do the thing, but better than the :py:meth:`parent ` “”” Todo el módulo es autodoc ed. Me gustaría tener un enlace a la implementación principal de x que se muestre como “principal”, no como ” parent “. […]

¿Puedo suprimir la expansión de variables en la documentación de Sphinx?

En mi codigo tengo X_DEFAULT = [‘a’, ‘long’, ‘list’, ‘of’, ‘values’, ‘that’, ‘is’, ‘really’, ‘ugly’, ‘to’, ‘see’, ‘over’, ‘and’, ‘over’, ‘again’, ‘every’, ‘time’, ‘it’, ‘is’, ‘referred’, ‘to’, ‘in’, ‘the’, ‘documentation’] y después def some_function(…, x=X_DEFAULT, …): de modo que en mi documentación de Sphinx, usando (p. ej., usando .. autofunction:: , etc.) obtengo el valor […]