RST: enable parsing of prefix roles (ref #17340) (#17514)

This commit is contained in:
Andrey Makarov 2021-03-29 19:32:49 +03:00 • committed by GitHub
commit 861c42c258
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 70 additions and 18 deletions

View file

@ -285,6 +285,15 @@ or
the first is preferred.
When you specify an *RST role* (highlighting/interpretation marker) do it
in the postfix form for uniformity, that is after \`text in backticks\`.
For example an ``:idx:`` role for referencing a topic ("SQLite" in the
example below) from `Nim Index`_ can be used in doc comment this way:
.. code-block:: nim
## A higher level `SQLite`:idx: database wrapper.
.. _`Nim Index`: https://nim-lang.org/docs/theindex.html
Best practices
==============