[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v2 02/11] [DO-NOT-MERGE] docs/sphinx: change default role to "any
From: |
John Snow |
Subject: |
[PATCH v2 02/11] [DO-NOT-MERGE] docs/sphinx: change default role to "any" |
Date: |
Mon, 26 Oct 2020 15:42:42 -0400 |
This interprets single-backtick syntax in all of our Sphinx docs as a
cross-reference to *something*, including Python symbols.
Signed-off-by: John Snow <jsnow@redhat.com>
---
docs/conf.py | 3 +++
1 file changed, 3 insertions(+)
diff --git a/docs/conf.py b/docs/conf.py
index e584f683938..bbc71ebdc36 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -84,6 +84,9 @@
# The master toctree document.
master_doc = 'index'
+# Interpret `this` to be a cross-reference to "anything".
+default_role = 'any'
+
# General information about the project.
project = u'QEMU'
copyright = u'2020, The QEMU Project Developers'
--
2.26.2
- [PATCH v2 00/11] qapi: static typing conversion, pt2, John Snow, 2020/10/26
- [PATCH v2 02/11] [DO-NOT-MERGE] docs/sphinx: change default role to "any",
John Snow <=
- [PATCH v2 11/11] qapi/introspect.py: Add docstring to _tree_to_qlit, John Snow, 2020/10/26
- [PATCH v2 04/11] qapi/introspect.py: add assertions and casts, John Snow, 2020/10/26
- [PATCH v2 03/11] [DO-NOT-MERGE] docs: enable sphinx-autodoc for scripts/qapi, John Snow, 2020/10/26
- [PATCH v2 06/11] qapi/introspect.py: add _gen_features helper, John Snow, 2020/10/26
- [PATCH v2 08/11] qapi/introspect.py: replace 'extra' dict with 'comment' argument, John Snow, 2020/10/26
- [PATCH v2 07/11] qapi/introspect.py: Unify return type of _make_tree(), John Snow, 2020/10/26
- [PATCH v2 10/11] qapi/introspect.py: improve readability of _tree_to_qlit, John Snow, 2020/10/26
- [PATCH v2 01/11] [DO-NOT-MERGE] docs: replace single backtick (`) with double-backtick (``), John Snow, 2020/10/26
- [PATCH v2 09/11] qapi/introspect.py: create a typed 'Annotated' data strutcure, John Snow, 2020/10/26
- [PATCH v2 05/11] qapi/introspect.py: add preliminary type hint annotations, John Snow, 2020/10/26