Re: [PATCH 1/2] docs: remove non-reference uses of single backticks

2021-08-05 Thread Peter Maydell
On Thu, 5 Aug 2021 at 01:48, John Snow wrote: > > 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 u

[PATCH 1/2] docs: remove non-reference uses of single backticks

2021-08-04 Thread John Snow
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 i