• John Snow's avatar
    docs: remove non-reference uses of single backticks · 450e0f28
    John Snow authored and Marc-André Lureau's avatar Marc-André Lureau committed
    
    
    The single backtick markup in ReST is the "default role". Currently,
    Sphinx's default role is called "content". Sphinx suggests you can use
    the "Any" role instead to turn any single-backtick enclosed item into a
    cross-reference.
    
    This is useful for things like autodoc for Python docstrings, where it's
    often nicer to reference other types with `foo` instead of the more
    laborious :py:meth:`foo`. It's also useful in multi-domain cases to
    easily reference definitions from other Sphinx domains, such as
    referencing C code definitions from outside of kerneldoc comments.
    
    Before we do that, though, we'll need to turn all existing usages of the
    "content" role to inline verbatim markup wherever it does not correctly
    resolve into a cross-refernece by using double backticks instead.
    Signed-off-by: John Snow's avatarJohn Snow <jsnow@redhat.com>
    Reviewed-by: default avatarEduardo Habkost <ehabkost@redhat.com>
    Reviewed-by: Alexander Bulekov's avatarAlexander Bulekov <alxndr@bu.edu>
    Message-Id: <20211004215238.1523082-2-jsnow@redhat.com>
    450e0f28