Search code examples
documentationrestructuredtextdocumentation-generation

How to force end of some admonitions in a RST file

I have a note in a reStructuredText formatted text that will be placed between a point of a list, and its sublist. The problem is that the note include the sublist.

Here is an extract of the file:

3. Select build parameters on the `CI              
   <https://website.com/CI>`_ and run it on your
   remote  branch.
 
.. note::

   The text of the note.

   a. If the failure is not related to your changes, say so in the pull request
      comments.
   b. Then, make the appropriate fixes.

 4. Wait for comments or approval. If modifications are requested by the
    comments, consider implementing them.

When I compile it, a. and b. are included into the note. But I don't want that. Is there a way to force the note to end after The text of the note. ?

Solution

  • This answer is wrong. See the comments for why. See Steve Piercy's answer for a correct one.

    Probably something like the following:

    3. Select build parameters on the `CI
   <https://website.com/CI>`_ and run it on your
   remote  branch.

.. note::

   The text of the note.

..

   a. If the failure is not related to your changes, say so in the pull request
      comments.
   b. Then, make the appropriate fixes.

4. Wait for comments or approval. If modifications are requested by the
comments, consider implementing them.