Articles of restructuredtext

¿Cómo analizar el texto reestructurado en python?

¿Hay algún módulo que pueda analizar el texto reestructurado en un modelo de árbol? ¿Puede hacer esto docutils o sphinx?

¿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.

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

¿Cómo se obtiene la documentación de Python en formato de información de Texinfo?

Desde Python 2.6, parece que la documentación está en el nuevo formato reStructuredText , y ya no parece muy fácil construir un archivo de información de Texinfo desde la caja. Soy un adicto a Emacs y prefiero que mi documentación esté instalada en Info. ¿Alguien tiene Python 2.6 o documentos posteriores en formato Texinfo? ¿Cómo […]

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

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 “. […]

Evite el anidamiento de subsecciones en Python Sphinx cuando se usa toctree

Tengo un problema al estructurar mi guía de usuarios de Sphinx. Me gustaría formar un capítulo teniendo una página de inicio principal (index.rst) que contenga el encabezado del capítulo y una descripción general, y luego subsecciones separadas contenidas en diferentes archivos (part1.rst, part2.rst). Estoy tratando de usar “toctree” para insertar las subsecciones separadas, pero me […]

Extraer lista de campos de reStructuredText

Digamos que tengo la siguiente entrada reST: Some text … :foo: bar Some text … Lo que me gustaría terminar es un dictado como este: {“foo”: “bar”} Intenté usar esto: tree = docutils.core.publish_parts(text) ¿Analiza la lista de campos, pero termino con un pseudo XML en el tree[“whole”]? : <document source="”> foo bar Como el dict […]

‘Título de sección inesperado’ con Sphinx: ¿es el problema el problema?

Cuando se ejecuta sphinx-build . html/ en mi directorio doc/ , obtengo el siguiente resultado: $ sphinx-build . html/ Running Sphinx v0.6.4 No builder selected, using default: html loading pickled environment… done building [html]: targets for 0 source files that are out of date updating environment: 0 added, 1 changed, 0 removed reading sources… [100%] […]