Preguntas etiquetadas con restructuredtext

Sé que reStructuredText tiene esta directiva: .. code:: bash gedit pohl.m que representa un bloque de código. ¿Hay alguna forma de obtener resaltado de sintaxis para fragmentos en línea como este: Do edit the file, type ``gedit pohl.m`` into a terminal. Los backticks lo marcan como código, pero me gustaría …

130 restructuredtext 

Las respuestas de esta pregunta son un esfuerzo comunitario . Edite las respuestas existentes para mejorar esta publicación. Actualmente no acepta nuevas respuestas o interacciones. Soy un gran admirador de reStructuredText , sin embargo, las herramientas que lo soportan están dispersas por todo Internet. La lista oficial de herramientas está …

128 restructuredtext 

Tengo un proyecto alojado en GitHub. Para esto, he escrito mi README usando la sintaxis de Markdown para tenerlo bien formateado en GitHub. Como mi proyecto está en Python, también planeo subirlo a PyPi . La sintaxis utilizada para READMEs en PyPi es reStructuredText. Me gustaría evitar tener que manejar …

116 python  github  markdown  restructuredtext  pypi 

¿Cómo insertar una referencia cruzada en una página reST / Sphinx a un subencabezado o un ancla en otra página en el mismo conjunto de documentación?

110 python-sphinx  restructuredtext 

Tal como está actualmente, esta pregunta no se ajusta bien a nuestro formato de preguntas y respuestas. Esperamos que las respuestas estén respaldadas por hechos, referencias o experiencia, pero es probable que esta pregunta solicite debate, argumentos, encuestas o una discusión extensa. Si cree que esta pregunta se puede mejorar …

90 documentation  markdown  markup  restructuredtext  textile 

Estoy tratando de crear una lista correctamente anidada usando el siguiente código (siguiendo los documentos de Sphinx y docutils ): 1. X a. U b. V c. W 2. Y 3. Z Espero que esto dé como resultado dos OLs, pero obtengo el siguiente resultado: <ol class="arabic simple"> <li>X</li> </ol> …

90 markup  restructuredtext  python-sphinx 

Esto es lo que me gustaría hacer: 1. `link <http://www.google.com>`__ 2. `link <http://www.yahoo.com>`__ Para obtener: <ol> <li><a href="http://www.google.com">link</a></li> <li><a href="http://www.yahoo.com">link</a></li> </ol> El contexto es una lista de publicaciones, donde quiero que todas tengan un enlace marcado "DOI" al final. Sin embargo, esto parece fallar con: <string>:3: (WARNING/2) Duplicate explicit target …

81 python  restructuredtext 

¿Cómo se formatea el texto dentro de un enlace indicado en reStructuredText? Específicamente, deseo generar el siguiente HTML a partir de mi primera: <a href="http://docs.python.org/library/optparse.html"><tt>optparse.OptionParser</tt> documentation documentation</a> El resultado debería verse así: optparse.OptionParser documentación donde la parte "optparse.OptionParser" está en una fuente de ancho fijo. Lo intenté ```optparse.OptionParser`` <http://docs.python.org/library/optparse.html>`_ sin …

81 python-sphinx  restructuredtext