[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-commits] [qemu/qemu] cd0a9e: docs/sphinx: add loaded modules to ge
|
From: |
Richard Henderson |
|
Subject: |
[Qemu-commits] [qemu/qemu] cd0a9e: docs/sphinx: add loaded modules to generated depfile |
|
Date: |
Mon, 08 Nov 2021 07:21:57 -0800 |
Branch: refs/heads/master
Home: https://github.com/qemu/qemu
Commit: cd0a9e983c984e3a6a08397dc2ca4500886ec48b
https://github.com/qemu/qemu/commit/cd0a9e983c984e3a6a08397dc2ca4500886ec48b
Author: Marc-André Lureau <marcandre.lureau@redhat.com>
Date: 2021-11-08 (Mon, 08 Nov 2021)
Changed paths:
M docs/sphinx/depfile.py
Log Message:
-----------
docs/sphinx: add loaded modules to generated depfile
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
Reviewed-by: Paolo Bonzini <pbonzini@redhat.com>
Commit: 905655ea6ab6f25371415f2483e02ab34e3bb98a
https://github.com/qemu/qemu/commit/905655ea6ab6f25371415f2483e02ab34e3bb98a
Author: Marc-André Lureau <marcandre.lureau@redhat.com>
Date: 2021-11-08 (Mon, 08 Nov 2021)
Changed paths:
M docs/sphinx/depfile.py
Log Message:
-----------
docs/sphinx: add static files to generated depfile
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
Reviewed-by: Paolo Bonzini <pbonzini@redhat.com>
Commit: 0dd35c16297a365bc99115284ab3e77da9986368
https://github.com/qemu/qemu/commit/0dd35c16297a365bc99115284ab3e77da9986368
Author: Marc-André Lureau <marcandre.lureau@redhat.com>
Date: 2021-11-08 (Mon, 08 Nov 2021)
Changed paths:
M docs/conf.py
M docs/sphinx/depfile.py
Log Message:
-----------
docs/sphinx: add templates files to generated depfile
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
Reviewed-by: Paolo Bonzini <pbonzini@redhat.com>
Commit: 706bbad2bacf21bed3e61d99203afe85b73f97f1
https://github.com/qemu/qemu/commit/706bbad2bacf21bed3e61d99203afe85b73f97f1
Author: Marc-André Lureau <marcandre.lureau@redhat.com>
Date: 2021-11-08 (Mon, 08 Nov 2021)
Changed paths:
M tests/qapi-schema/meson.build
Log Message:
-----------
tests/qapi-schema/meson: add depfile to sphinx doc
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
Reviewed-by: Paolo Bonzini <pbonzini@redhat.com>
Commit: 89bcfe780a8e1a900d94014dfdef756cc3eb8221
https://github.com/qemu/qemu/commit/89bcfe780a8e1a900d94014dfdef756cc3eb8221
Author: Marc-André Lureau <marcandre.lureau@redhat.com>
Date: 2021-11-08 (Mon, 08 Nov 2021)
Changed paths:
M docs/meson.build
M tests/qapi-schema/meson.build
Log Message:
-----------
meson: drop sphinx_extn_depends
Module dependencies is now handled by depfile.py.
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
Reviewed-by: Paolo Bonzini <pbonzini@redhat.com>
Commit: ed9e6d65edaeeefd33eaa873ab983d170bd8b3c9
https://github.com/qemu/qemu/commit/ed9e6d65edaeeefd33eaa873ab983d170bd8b3c9
Author: Marc-André Lureau <marcandre.lureau@redhat.com>
Date: 2021-11-08 (Mon, 08 Nov 2021)
Changed paths:
M docs/meson.build
Log Message:
-----------
meson: drop sphinx_template_files
Static files dependencies is now handled by depfile.py.
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
Reviewed-by: Paolo Bonzini <pbonzini@redhat.com>
Commit: 96871b38547211d8d91e7d059a3322e67b53657c
https://github.com/qemu/qemu/commit/96871b38547211d8d91e7d059a3322e67b53657c
Author: Marc-André Lureau <marcandre.lureau@redhat.com>
Date: 2021-11-08 (Mon, 08 Nov 2021)
Changed paths:
M docs/conf.py
Log Message:
-----------
docs/sphinx: set navigation_with_keys=True
Allow navigating to the previous/next page using the keyboard's left and
right arrows. I wish this would be the default, and that the themes
would provide more key navigation, but that doesn't seem on the roadmap.
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
Reviewed-by: Paolo Bonzini <pbonzini@redhat.com>
Commit: 9423751645d27ae1146ca645431c368f09cb3b6c
https://github.com/qemu/qemu/commit/9423751645d27ae1146ca645431c368f09cb3b6c
Author: Marc-André Lureau <marcandre.lureau@redhat.com>
Date: 2021-11-08 (Mon, 08 Nov 2021)
Changed paths:
M docs/conf.py
A docs/sphinx-static/custom.js
Log Message:
-----------
docs/sphinx: add 's' keyboard binding to focus search
This is pretty ubiquitous. ('/' is already taken by some browsers for
quick search)
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
Reviewed-by: Paolo Bonzini <pbonzini@redhat.com>
Commit: 450e0f28a476342baf1ed14a6c2a230e738f83bf
https://github.com/qemu/qemu/commit/450e0f28a476342baf1ed14a6c2a230e738f83bf
Author: John Snow <jsnow@redhat.com>
Date: 2021-11-08 (Mon, 08 Nov 2021)
Changed paths:
M docs/devel/fuzzing.rst
M docs/devel/tcg-plugins.rst
M docs/interop/live-block-operations.rst
M docs/system/guest-loader.rst
M include/qemu/module.h
M qapi/block-core.json
M qemu-options.hx
Log Message:
-----------
docs: remove non-reference uses of single backticks
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 it's
often nicer to reference other types with `foo` instead of the more
laborious :py:meth:`foo`. It's also useful in multi-domain cases to
easily reference definitions from other Sphinx domains, such as
referencing C code definitions from outside of kerneldoc comments.
Before we do that, though, we'll need to turn all existing usages of the
"content" role to inline verbatim markup wherever it does not correctly
resolve into a cross-refernece by using double backticks instead.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Eduardo Habkost <ehabkost@redhat.com>
Reviewed-by: Alexander Bulekov <alxndr@bu.edu>
Message-Id: <20211004215238.1523082-2-jsnow@redhat.com>
Commit: ca0a0d122c760a0763c68f348560bddfe482813c
https://github.com/qemu/qemu/commit/ca0a0d122c760a0763c68f348560bddfe482813c
Author: John Snow <jsnow@redhat.com>
Date: 2021-11-08 (Mon, 08 Nov 2021)
Changed paths:
M docs/devel/build-system.rst
M docs/system/i386/sgx.rst
Log Message:
-----------
docs: (further) remove non-reference uses of single backticks
The series rotted already. Here's the new changes.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Damien Hedde <damien.hedde@greensocs.com>
[ extra backticks fixes ]
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Message-Id: <20211004215238.1523082-3-jsnow@redhat.com>
Commit: c11b3a1dd324d1f7dc8512bb840ffd8226fbd0a7
https://github.com/qemu/qemu/commit/c11b3a1dd324d1f7dc8512bb840ffd8226fbd0a7
Author: John Snow <jsnow@redhat.com>
Date: 2021-11-08 (Mon, 08 Nov 2021)
Changed paths:
M docs/conf.py
Log Message:
-----------
docs/sphinx: change default role to "any"
This interprets single-backtick syntax in all of our Sphinx docs as a
cross-reference to *something*, including Python symbols.
>From here on out, new uses of `backticks` will cause a build failure if
the target cannot be referenced.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Eduardo Habkost <ehabkost@redhat.com>
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Message-Id: <20211004215238.1523082-4-jsnow@redhat.com>
Commit: 260f9210d2ce892c5e162a45b0e5ec0036bedc79
https://github.com/qemu/qemu/commit/260f9210d2ce892c5e162a45b0e5ec0036bedc79
Author: Richard Henderson <richard.henderson@linaro.org>
Date: 2021-11-08 (Mon, 08 Nov 2021)
Changed paths:
M docs/conf.py
M docs/devel/build-system.rst
M docs/devel/fuzzing.rst
M docs/devel/tcg-plugins.rst
M docs/interop/live-block-operations.rst
M docs/meson.build
A docs/sphinx-static/custom.js
M docs/sphinx/depfile.py
M docs/system/guest-loader.rst
M docs/system/i386/sgx.rst
M include/qemu/module.h
M qapi/block-core.json
M qemu-options.hx
M tests/qapi-schema/meson.build
Log Message:
-----------
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>
Compare: https://github.com/qemu/qemu/compare/63ed851de474...260f9210d2ce