qemu-commits
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Qemu-commits] [qemu/qemu] 542f2d: docs/sphinx: add loaded modules to ge


From: Richard Henderson
Subject: [Qemu-commits] [qemu/qemu] 542f2d: docs/sphinx: add loaded modules to generated depfile
Date: Fri, 05 Nov 2021 10:20:24 -0700

  Branch: refs/heads/staging
  Home:   https://github.com/qemu/qemu
  Commit: 542f2dff97ef8d420b0b769e872d9920fb760d0e
      
https://github.com/qemu/qemu/commit/542f2dff97ef8d420b0b769e872d9920fb760d0e
  Author: Marc-André Lureau <marcandre.lureau@redhat.com>
  Date:   2021-11-05 (Fri, 05 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: bf59895010264c095c60fff2c5a1ce0edb62059f
      
https://github.com/qemu/qemu/commit/bf59895010264c095c60fff2c5a1ce0edb62059f
  Author: Marc-André Lureau <marcandre.lureau@redhat.com>
  Date:   2021-11-05 (Fri, 05 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: a4ae412819676b3ea8594454920ce01654beac2c
      
https://github.com/qemu/qemu/commit/a4ae412819676b3ea8594454920ce01654beac2c
  Author: Marc-André Lureau <marcandre.lureau@redhat.com>
  Date:   2021-11-05 (Fri, 05 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: 358dec4870293f4e8d869ff257352a1cedde6a89
      
https://github.com/qemu/qemu/commit/358dec4870293f4e8d869ff257352a1cedde6a89
  Author: Marc-André Lureau <marcandre.lureau@redhat.com>
  Date:   2021-11-05 (Fri, 05 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: 0abfa7d887cb579d32fa796997bd39aa5d7fe2bc
      
https://github.com/qemu/qemu/commit/0abfa7d887cb579d32fa796997bd39aa5d7fe2bc
  Author: Marc-André Lureau <marcandre.lureau@redhat.com>
  Date:   2021-11-05 (Fri, 05 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: 86abffd4e95e156a2d1da4b1d5b245ac69c9893f
      
https://github.com/qemu/qemu/commit/86abffd4e95e156a2d1da4b1d5b245ac69c9893f
  Author: Marc-André Lureau <marcandre.lureau@redhat.com>
  Date:   2021-11-05 (Fri, 05 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: b41a1a8916ff7c76c130a3fb550d69501e4f8870
      
https://github.com/qemu/qemu/commit/b41a1a8916ff7c76c130a3fb550d69501e4f8870
  Author: Marc-André Lureau <marcandre.lureau@redhat.com>
  Date:   2021-11-05 (Fri, 05 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: f7b5d3ae35a79a1798f4d606a9a16350bac36ddc
      
https://github.com/qemu/qemu/commit/f7b5d3ae35a79a1798f4d606a9a16350bac36ddc
  Author: Marc-André Lureau <marcandre.lureau@redhat.com>
  Date:   2021-11-05 (Fri, 05 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: ff35c848dd432addb8e184747087acdfd939d197
      
https://github.com/qemu/qemu/commit/ff35c848dd432addb8e184747087acdfd939d197
  Author: John Snow <jsnow@redhat.com>
  Date:   2021-11-05 (Fri, 05 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: 558ffb1d07549370efac67523a18f276050c5c42
      
https://github.com/qemu/qemu/commit/558ffb1d07549370efac67523a18f276050c5c42
  Author: John Snow <jsnow@redhat.com>
  Date:   2021-11-05 (Fri, 05 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: e6e89422ed6907d14ea67f2b99269e6b5554d6be
      
https://github.com/qemu/qemu/commit/e6e89422ed6907d14ea67f2b99269e6b5554d6be
  Author: John Snow <jsnow@redhat.com>
  Date:   2021-11-05 (Fri, 05 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: 1f50681331792b74ea59dd9dbf00a48d5c854b4e
      
https://github.com/qemu/qemu/commit/1f50681331792b74ea59dd9dbf00a48d5c854b4e
  Author: Richard Henderson <richard.henderson@linaro.org>
  Date:   2021-11-05 (Fri, 05 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 Fri 05 Nov 2021 09:31:14 AM EDT
# 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/c39deb218178...1f5068133179



reply via email to

[Prev in Thread] Current Thread [Next in Thread]