diff options
| author | Richard Henderson <richard.henderson@linaro.org> | 2021-11-08 14:56:10 +0100 |
|---|---|---|
| committer | Richard Henderson <richard.henderson@linaro.org> | 2021-11-08 14:56:10 +0100 |
| commit | 260f9210d2ce892c5e162a45b0e5ec0036bedc79 (patch) | |
| tree | d6262096025eab3b09fbd16e6c3588ed70fc5e83 /docs/conf.py | |
| parent | 63ed851de474b1e2458cb9b4ba6e02a88f72c25c (diff) | |
| parent | c11b3a1dd324d1f7dc8512bb840ffd8226fbd0a7 (diff) | |
| download | focaccia-qemu-260f9210d2ce892c5e162a45b0e5ec0036bedc79.tar.gz focaccia-qemu-260f9210d2ce892c5e162a45b0e5ec0036bedc79.zip | |
Merge remote-tracking branch 'remotes/marcandre.lureau/tags/sphinx-pull-request' into staging
Some Sphinx improvements PR for 2 series: https://patchew.org/QEMU/20211015105344.152591-1-marcandre.lureau@redhat.com/ https://patchew.org/QEMU/20211004215238.1523082-1-jsnow@redhat.com/ # gpg: Signature made Mon 08 Nov 2021 10:01:03 AM CET # gpg: using RSA key 87A9BD933F87C606D276F62DDAE8E10975969CE5 # gpg: issuer "marcandre.lureau@redhat.com" # gpg: Good signature from "Marc-André Lureau <marcandre.lureau@redhat.com>" [full] # gpg: aka "Marc-André Lureau <marcandre.lureau@gmail.com>" [full] * remotes/marcandre.lureau/tags/sphinx-pull-request: docs/sphinx: change default role to "any" docs: (further) remove non-reference uses of single backticks docs: remove non-reference uses of single backticks docs/sphinx: add 's' keyboard binding to focus search docs/sphinx: set navigation_with_keys=True meson: drop sphinx_template_files meson: drop sphinx_extn_depends tests/qapi-schema/meson: add depfile to sphinx doc docs/sphinx: add templates files to generated depfile docs/sphinx: add static files to generated depfile docs/sphinx: add loaded modules to generated depfile Signed-off-by: Richard Henderson <richard.henderson@linaro.org>
Diffstat (limited to 'docs/conf.py')
| -rw-r--r-- | docs/conf.py | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/docs/conf.py b/docs/conf.py index ff6e92c6e2..763e7d2434 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -74,7 +74,7 @@ needs_sphinx = '1.6' extensions = ['kerneldoc', 'qmp_lexer', 'hxtool', 'depfile', 'qapidoc'] # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = [os.path.join(qemu_docdir, '_templates')] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: @@ -85,6 +85,11 @@ source_suffix = '.rst' # The master toctree document. master_doc = 'index' +# Interpret `single-backticks` to be a cross-reference to any kind of +# referenceable object. Unresolvable or ambiguous references will emit a +# warning at build time. +default_role = 'any' + # General information about the project. project = u'QEMU' copyright = u'2021, The QEMU Project Developers' @@ -166,6 +171,7 @@ html_theme = 'sphinx_rtd_theme' if LooseVersion(sphinx_rtd_theme.__version__) >= LooseVersion("0.4.3"): html_theme_options = { "style_nav_header_background": "#802400", + "navigation_with_keys": True, } html_logo = os.path.join(qemu_docdir, "../ui/icons/qemu_128x128.png") @@ -181,6 +187,10 @@ html_css_files = [ 'theme_overrides.css', ] +html_js_files = [ + 'custom.js', +] + html_context = { "display_gitlab": True, "gitlab_user": "qemu-project", |