Articles of python sphinx

sphinx automodule: ¿cómo hacer referencia a las clases en el mismo módulo?

Estoy tratando de usar la extensión autodoc sphinx y específicamente la directiva automodule para generar automáticamente la documentación para la aplicación django en la que estoy trabajando. El problema es que quiero crear referencias internas a diferentes clases dentro del módulo, sin tener que usar autoclase y autofuncionar en cada clase / función dentro del […]

Mostrar todo el texto en la barra lateral Leer los documentos.

Según tengo entendido, el nuevo tema Leer los documentos genera la barra lateral del toctree con una profundidad de 2. Mi documentación es relativamente profunda y una profundidad de 2 no es suficiente para que sea útil. ¿Cómo puedo boost este límite, o preferiblemente eliminarlo por completo? Si eso no es razonablemente posible, ¿cómo puedo […]

¿Repetir la cuadrícula de imagen con subtítulos?

Como una extensión de esta pregunta : ¿cómo puede agregar una descripción debajo de cada una de las imágenes en cuadrícula utilizando Sphinx y reStructuredText? Por ejemplo, una tabla, tres imágenes con un título centrado debajo de cada imagen.

Progtwig de línea de comandos de Python: genere una página de manual a partir de la documentación existente e incluya en la distribución

Siguiendo una práctica común (con suerte), tengo un paquete de Python que incluye varios módulos y un script ejecutable en un directorio de scripts separado, como se puede ver aquí . La documentación para el script, además de la ayuda generada automáticamente por optparse, está junto con la documentación del paquete en un subdirectorio Sphinx. […]

Cómo crear directivas personalizadas en Sphinx.

Actualmente estoy documentando una API de descanso escrita en Python. Toda la documentación del proyecto se crea con Sphinx, y para la API REST me gustaría crear algunas directivas especiales. Por ejemplo, digamos que tengo este recurso definido: @resource(“/user/”, method=”GET”) def user_details (email): “”” Returns detailed information about a user account. :resource GET: /user/ :query_param […]

¿Cómo express varios tipos para un solo parámetro o un valor de retorno en las cadenas de documentos procesadas por Sphinx?

A veces, una función en Python puede aceptar un argumento de un tipo flexible. O puede devolver un valor de un tipo flexible. Ahora no puedo recordar un buen ejemplo de tal función en este momento, por lo tanto, estoy demostrando cómo se ve esa función con un ejemplo de juguete a continuación. Quiero saber […]

Formato de tabla csv en las cadenas de documentación de Python (Sphinx): múltiples líneas en una celda

Estoy usando Sphinx para documentar un proyecto de Python. Parece que hay un poco de inconsistencia con la directiva .. csv-table:: . El problema principal es una nueva línea en una celda. Y mi cuestionable salud mental. El siguiente código: .. csv-table:: :header: Header1, Header2, Header3 A, B, “These lines appear as one line, even […]

Anulando el límite de nombre de campo predeterminado en sphinx / docutils

Estoy usando la esfinge para generar documentación html para un proyecto. Hago un amplio uso de las listas de campo . Al generar html, cada par de etiqueta / valor se representa como una sola fila de la tabla con dos celdas si la longitud de la etiqueta es como máximo de 14 caracteres. Si […]

Uso de la esfinge para documentar automáticamente una clase de python, módulo

He instalado Sphinx para documentar algunos módulos de Python y la clase en la que estoy trabajando. Si bien el lenguaje de marcado se ve muy bien, no he logrado documentar automáticamente un código de Python. Básicamente, tengo el siguiente módulo de python: SegLib.py Y una clase llamada Seg en ella. Me gustaría mostrar las […]

¿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í?