toctree - Reflejo de código en línea en reStructuredText

restructuredtext tutorial

Question

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 destacarlo con pygments como el bloque. es posible?

Answer 1

Habiendo examinado esto un poco más, me topé con el documento ReStructuredText Interpreted Text Roles . De este documento:

El texto interpretado usa comillas inversas (`) alrededor del texto. Un marcador explícito de roles puede aparecer opcionalmente antes o después del texto, delimitado con dos puntos. Por ejemplo:

This is `interpreted text` using the default role.

This is :title:`interpreted text` using an explicit role.

Parece que hay un rol de code , así que simplemente puede escribir

:code:`a = b + c`

para renderizar un bloque de código en línea. Para obtener resaltado de sintaxis, puede definir un rol personalizado. Por ejemplo

.. role:: bash(code)
   :language: bash

que luego puedes usar así:

Here is some awesome bash code :bash:`a = b + c`.

Tenga en cuenta que el documento al que enlazo no hace mención de la versión de docutils a los que se refiere. La función de código no está disponible en docutils 0.8.1 (que es la única versión que tengo que probar).