O domínio reStructuredText¶

Adicionado na versão 1.0.

O domínio reStructuredText (nome rst) fornece as seguintes diretivas:

.. rst:directive:: name¶

Descreve uma diretiva reStructuredText. O name pode ser um único nome de diretiva ou uma sintaxe de diretiva real (prefixo .. e sufixo ::) com argumentos que serão renderizados de forma diferente. Por exemplo:

.. rst:directive:: foo

   Foo description.

.. rst:directive:: .. bar:: baz

   Bar description.

será renderizado como:

.. foo::¶: Foo description.

.. bar:: baz¶: Bar description.

.. rst:directive:option:: name¶

Descreve uma opção para a diretiva reStructuredText. O name pode ser um nome de opção única ou um nome de opção com argumentos separados por dois pontos (:). Por exemplo:

.. rst:directive:: toctree

   .. rst:directive:option:: caption: caption of ToC

   .. rst:directive:option:: glob

será renderizado como:

.. toctree::

:caption: caption of ToC

:glob:

opções

:type: description of argument (text)¶

Descreve o tipo de valor da opção.

Por exemplo:

.. rst:directive:: toctree

   .. rst:directive:option:: maxdepth
      :type: integer or no value

Adicionado na versão 2.1.

.. rst:role:: name¶

Descreve um papel reStructuredText. Por exemplo:

.. rst:role:: foo

   Foo description.

será renderizado como:

:foo:¶: Foo description.

Essas funções são fornecidas para fazer referência aos objetos descritos:

:rst:dir:¶

Diretivas de referência e opções de diretivas. Exemplos:

Use :rst:dir:`minha-diretiva` para referenciar uma diretiva.
Use :rst:dir:`minha-diretiva:minha-opção` para referenciar uma opção de diretiva.

:rst:role:¶: Faz referência a um papel. Exemplo: :rst:role:`my-role`.