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

2021-09-23 Thread John Snow
On Thu, Sep 23, 2021 at 2:33 PM Eduardo Habkost wrote: > On Thu, Sep 23, 2021 at 02:22:03PM -0400, 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 tur

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

2021-09-23 Thread Eduardo Habkost
On Thu, Sep 23, 2021 at 02:22:03PM -0400, 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. >

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

2021-09-23 Thread Peter Maydell
On Thu, 23 Sept 2021 at 19:22, 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

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

2021-09-23 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