[PULL 00/11] Sphinx patches

marcandre.lureau@redhat.com posted 11 patches 2 years, 6 months ago
Test checkpatch passed
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20211105133222.184722-1-marcandre.lureau@redhat.com
Maintainers: Markus Armbruster <armbru@redhat.com>, Qiuhao Li <Qiuhao.Li@outlook.com>, "Alex Bennée" <alex.bennee@linaro.org>, Alexandre Iooss <erdnaxe@crans.org>, Alexander Bulekov <alxndr@bu.edu>, Eric Blake <eblake@redhat.com>, Bandan Das <bsd@redhat.com>, Thomas Huth <thuth@redhat.com>, Paolo Bonzini <pbonzini@redhat.com>, Stefan Hajnoczi <stefanha@redhat.com>, Darren Kenny <darren.kenny@oracle.com>, Mahmoud Mandour <ma.mandourr@gmail.com>, Peter Maydell <peter.maydell@linaro.org>
There is a newer version of this series
docs/conf.py                           | 12 +++++++++++-
docs/devel/build-system.rst            | 16 ++++++++--------
docs/devel/fuzzing.rst                 |  9 +++++----
docs/devel/tcg-plugins.rst             |  2 +-
docs/interop/live-block-operations.rst |  2 +-
docs/meson.build                       | 10 ----------
docs/sphinx-static/custom.js           |  9 +++++++++
docs/sphinx/depfile.py                 | 19 +++++++++++++++++--
docs/system/guest-loader.rst           |  2 +-
docs/system/i386/sgx.rst               |  6 +++---
qapi/block-core.json                   |  4 ++--
include/qemu/module.h                  |  6 +++---
qemu-options.hx                        |  4 ++--
tests/qapi-schema/meson.build          |  6 ++++--
14 files changed, 67 insertions(+), 40 deletions(-)
create mode 100644 docs/sphinx-static/custom.js
[PULL 00/11] Sphinx patches
Posted by marcandre.lureau@redhat.com 2 years, 6 months ago
From: Marc-André Lureau <marcandre.lureau@redhat.com>

The following changes since commit 18e356a53a2926a15343b914db64324d63748f25:

  Merge remote-tracking branch 'remotes/stsquad/tags/pull-for-6.2-041121-2' into staging (2021-11-04 08:33:46 -0400)

are available in the Git repository at:

  git@gitlab.com:marcandre.lureau/qemu.git tags/sphinx-pull-request

for you to fetch changes up to e6e89422ed6907d14ea67f2b99269e6b5554d6be:

  docs/sphinx: change default role to "any" (2021-11-05 17:22:04 +0400)

----------------------------------------------------------------
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/

----------------------------------------------------------------

John Snow (3):
  docs: remove non-reference uses of single backticks
  docs: (further) remove non-reference uses of single backticks
  docs/sphinx: change default role to "any"

Marc-André Lureau (8):
  docs/sphinx: add loaded modules to generated depfile
  docs/sphinx: add static files to generated depfile
  docs/sphinx: add templates files to generated depfile
  tests/qapi-schema/meson: add depfile to sphinx doc
  meson: drop sphinx_extn_depends
  meson: drop sphinx_template_files
  docs/sphinx: set navigation_with_keys=True
  docs/sphinx: add 's' keyboard binding to focus search

 docs/conf.py                           | 12 +++++++++++-
 docs/devel/build-system.rst            | 16 ++++++++--------
 docs/devel/fuzzing.rst                 |  9 +++++----
 docs/devel/tcg-plugins.rst             |  2 +-
 docs/interop/live-block-operations.rst |  2 +-
 docs/meson.build                       | 10 ----------
 docs/sphinx-static/custom.js           |  9 +++++++++
 docs/sphinx/depfile.py                 | 19 +++++++++++++++++--
 docs/system/guest-loader.rst           |  2 +-
 docs/system/i386/sgx.rst               |  6 +++---
 qapi/block-core.json                   |  4 ++--
 include/qemu/module.h                  |  6 +++---
 qemu-options.hx                        |  4 ++--
 tests/qapi-schema/meson.build          |  6 ++++--
 14 files changed, 67 insertions(+), 40 deletions(-)
 create mode 100644 docs/sphinx-static/custom.js

-- 
2.33.0.721.g106298f7f9



Re: [PULL 00/11] Sphinx patches
Posted by Richard Henderson 2 years, 6 months ago
On 11/5/21 9:32 AM, marcandre.lureau@redhat.com wrote:
> From: Marc-André Lureau <marcandre.lureau@redhat.com>
> 
> The following changes since commit 18e356a53a2926a15343b914db64324d63748f25:
> 
>    Merge remote-tracking branch 'remotes/stsquad/tags/pull-for-6.2-041121-2' into staging (2021-11-04 08:33:46 -0400)
> 
> are available in the Git repository at:
> 
>    git@gitlab.com:marcandre.lureau/qemu.git tags/sphinx-pull-request
> 
> for you to fetch changes up to e6e89422ed6907d14ea67f2b99269e6b5554d6be:
> 
>    docs/sphinx: change default role to "any" (2021-11-05 17:22:04 +0400)
> 
> ----------------------------------------------------------------
> 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/
> 
> ----------------------------------------------------------------
> 
> John Snow (3):
>    docs: remove non-reference uses of single backticks
>    docs: (further) remove non-reference uses of single backticks
>    docs/sphinx: change default role to "any"
> 
> Marc-André Lureau (8):
>    docs/sphinx: add loaded modules to generated depfile
>    docs/sphinx: add static files to generated depfile
>    docs/sphinx: add templates files to generated depfile
>    tests/qapi-schema/meson: add depfile to sphinx doc
>    meson: drop sphinx_extn_depends
>    meson: drop sphinx_template_files
>    docs/sphinx: set navigation_with_keys=True
>    docs/sphinx: add 's' keyboard binding to focus search
> 
>   docs/conf.py                           | 12 +++++++++++-
>   docs/devel/build-system.rst            | 16 ++++++++--------
>   docs/devel/fuzzing.rst                 |  9 +++++----
>   docs/devel/tcg-plugins.rst             |  2 +-
>   docs/interop/live-block-operations.rst |  2 +-
>   docs/meson.build                       | 10 ----------
>   docs/sphinx-static/custom.js           |  9 +++++++++
>   docs/sphinx/depfile.py                 | 19 +++++++++++++++++--
>   docs/system/guest-loader.rst           |  2 +-
>   docs/system/i386/sgx.rst               |  6 +++---
>   qapi/block-core.json                   |  4 ++--
>   include/qemu/module.h                  |  6 +++---
>   qemu-options.hx                        |  4 ++--
>   tests/qapi-schema/meson.build          |  6 ++++--
>   14 files changed, 67 insertions(+), 40 deletions(-)
>   create mode 100644 docs/sphinx-static/custom.js

One of the meson.build changes creates something that ninja does not like:

ninja: error: build.ninja:47298: multiple outputs aren't (yet?) supported by depslog; 
bring this up on the mailing list if it affects you

Makefile:162: recipe for target 'run-ninja' failed
make: *** [run-ninja] Error 1

which fails across multiple CI jobs:

https://gitlab.com/qemu-project/qemu/-/pipelines/403133805/failures


r~

Re: [PULL 00/11] Sphinx patches
Posted by Marc-André Lureau 2 years, 6 months ago
Hi

On Fri, Nov 5, 2021 at 10:07 PM Richard Henderson
<richard.henderson@linaro.org> wrote:
>
> On 11/5/21 9:32 AM, marcandre.lureau@redhat.com wrote:
> > From: Marc-André Lureau <marcandre.lureau@redhat.com>
> >
> > The following changes since commit 18e356a53a2926a15343b914db64324d63748f25:
> >
> >    Merge remote-tracking branch 'remotes/stsquad/tags/pull-for-6.2-041121-2' into staging (2021-11-04 08:33:46 -0400)
> >
> > are available in the Git repository at:
> >
> >    git@gitlab.com:marcandre.lureau/qemu.git tags/sphinx-pull-request
> >
> > for you to fetch changes up to e6e89422ed6907d14ea67f2b99269e6b5554d6be:
> >
> >    docs/sphinx: change default role to "any" (2021-11-05 17:22:04 +0400)
> >
> > ----------------------------------------------------------------
> > 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/
> >
> > ----------------------------------------------------------------
> >
> > John Snow (3):
> >    docs: remove non-reference uses of single backticks
> >    docs: (further) remove non-reference uses of single backticks
> >    docs/sphinx: change default role to "any"
> >
> > Marc-André Lureau (8):
> >    docs/sphinx: add loaded modules to generated depfile
> >    docs/sphinx: add static files to generated depfile
> >    docs/sphinx: add templates files to generated depfile
> >    tests/qapi-schema/meson: add depfile to sphinx doc
> >    meson: drop sphinx_extn_depends
> >    meson: drop sphinx_template_files
> >    docs/sphinx: set navigation_with_keys=True
> >    docs/sphinx: add 's' keyboard binding to focus search
> >
> >   docs/conf.py                           | 12 +++++++++++-
> >   docs/devel/build-system.rst            | 16 ++++++++--------
> >   docs/devel/fuzzing.rst                 |  9 +++++----
> >   docs/devel/tcg-plugins.rst             |  2 +-
> >   docs/interop/live-block-operations.rst |  2 +-
> >   docs/meson.build                       | 10 ----------
> >   docs/sphinx-static/custom.js           |  9 +++++++++
> >   docs/sphinx/depfile.py                 | 19 +++++++++++++++++--
> >   docs/system/guest-loader.rst           |  2 +-
> >   docs/system/i386/sgx.rst               |  6 +++---
> >   qapi/block-core.json                   |  4 ++--
> >   include/qemu/module.h                  |  6 +++---
> >   qemu-options.hx                        |  4 ++--
> >   tests/qapi-schema/meson.build          |  6 ++++--
> >   14 files changed, 67 insertions(+), 40 deletions(-)
> >   create mode 100644 docs/sphinx-static/custom.js
>
> One of the meson.build changes creates something that ninja does not like:
>
> ninja: error: build.ninja:47298: multiple outputs aren't (yet?) supported by depslog;
> bring this up on the mailing list if it affects you
>
> Makefile:162: recipe for target 'run-ninja' failed
> make: *** [run-ninja] Error 1
>
> which fails across multiple CI jobs:
>
> https://gitlab.com/qemu-project/qemu/-/pipelines/403133805/failures

A workaround is to keep a single output: in "tests/qapi-schema/meson:
add depfile to sphinx doc", and inline the doc-good.stamp argument.
I'll send v2.
thanks