how example code documentation python-sphinx restructuredtext

documentation - example - sphinx python



Negrita en cursiva en ReStructuredText (3)

Estoy escribiendo algo de documentación utilizando el formato ReStructuredText (ReST) para la última generación de páginas web utilizando Sphinx, y no puedo encontrar una forma de escribir texto en negrita y cursiva.

Hay marcadores para el llamado texto "énfasis" ( cursiva ) y "énfasis fuerte" ( negrita ). Son *italic text* y **bold text** respectivamente. También leí en algunos documentos sobre este formato que estos marcadores de formato no pueden ser simplemente "anidados". Es decir, el ***text*** (o ** *text* ** ) no produce el texto negrita y cursiva .

Todavía debería haber alguna manera de producir un texto enfatizado tanto con marcadores en negrita como en cursiva, ya que es una práctica generalizada marcar partes de texto de esa manera.


Aunque Markdown admite el anidamiento en negrita y cursiva, reStructuredText no lo hace (este es uno de los casos raros en los que Markdown es más poderoso, ya que no hay manera de representar negrita en cursiva en reStructuredText).

https://gist.github.com/1855764


En la esfinge, esto es posible a través de los roles de custome: usted crea un estilo en css y hace un rol que apunta a ese estilo. Aquí hay un ejemplo completo de trabajo de texto subrayado: hebra sphinx-dev .

Editar :

Aquí hay un buen ejemplo: tachado ReST


Receta para la salida HTML.

my.rst :

.. role:: red :class: red .. role:: bolditalic :class: bolditalic :red:`WARNING` :bolditalic:`Don''t be stupid!`

my.css :

.red { color: red; } .bolditalic { font-weight: bold; font-style: italic; }

Construido por:

rst2html --strip-comments --halt warning --stylesheet=my.css my.rst my.html