[lldb][docs] Use 'any' as the default role in LLDB's sphinx project
authorRaphael Isemann <teemperor@gmail.com>
Mon, 18 Jan 2021 18:07:51 +0000 (19:07 +0100)
committerRaphael Isemann <teemperor@gmail.com>
Mon, 18 Jan 2021 18:08:19 +0000 (19:08 +0100)
commita58aceffad61ebffb1a860763299b3307041efa6
tree3941c93388d48f4e4c1724794cc84cd03d5cf963
parent291ac7e622d542f8b25f74bc28051762edc90938
[lldb][docs] Use 'any' as the default role in LLDB's sphinx project

sphinx processes text in backticks depending on what 'role' it has (e.g.,
`:code:\`blub\`` -> role is `code`). If no role is provided, the default role is
taken which is right now using the default value of `content`. `content` only
really makes the text cursive which isn't really useful for anything right now.

Sphinx recommends using the `any` role by default [1] as that turns text in
backticks without an explicit roles into some kind of smart reference. If we did
this in LLDB, then we could just reference SB API classes by doing `\`SBValue\``
instead of typing out the rather verbose `:py:class:`/`:py:func:`/... role
before each reference. This would be especially nice when writing the SB API
docs itself as we constantly have to reference other classes.

[1] https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-any

Reviewed By: JDevlieghere

Differential Revision: https://reviews.llvm.org/D94899
lldb/docs/conf.py
lldb/docs/use/python.rst
lldb/docs/use/variable.rst