Articles of restructuredtext

Flujo de trabajo de documentación de Sphinx y JavaScript

Para mi framework de JavaScript me gustaría usar Sphinx. Ya que soy nuevo en el mundo de la esfinge, me gustaría que ustedes me ayuden a comenzar con Sphinx y JavaScript. Cualquier ayuda apreciada. Atentamente

reStructuredText: README.rst no analiza en PyPI

Tengo un proyecto de Python que está alojado tanto en Github como en PyPI. En Github: https://github.com/sloria/TextBlob/blob/master/README.rst En PyPi: https://pypi.python.org/pypi/textblob My README.rst no parece estar formateando correctamente en PyPI, pero se ve bien en Github. Ya he leído esto , pero no tengo ningún enlace en la página, así que ese no es el problema.

Python rtype docstring / texto reestructurado para fábricas / selectores de clase

: rtype: especifica que este es el tipo de objeto devuelto Por lo tanto, cuando creo un objeto obj en el siguiente fragmento, recibo una advertencia del IDE, que cls is not callable , ya que el IDE espera, que cls es un object del tipo SomeAbstractClass , y quiero el propio SomeAbstractClass IDE tiene […]

Cómo enlazar a la página raíz en intersphinx

He habilitado sphinx.ext.intersphinx en mi proyecto y he agregado la siguiente configuración: intersphinx_mapping = { ‘python’: (‘https://docs.python.org/3’, None), ‘pyserial’: (‘https://pythonhosted.org/pyserial/’, None), } Tengo lo siguiente en mi index.rst : This project depends on the :ref:`pyserial ` library. Me gustaría que el enlace apunte a http://pythonhosted.org/pyserial/ , la URL raíz en intersphinx_mapping , pero no sé […]

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