qapi: sphinx-autodoc for qapi module

[PATCH 0/3] qapi: sphinx-autodoc for qapi module

John Snow posted 3 patches 4 years, 11 months ago

Download series mbox

Test checkpatch passed

Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20201214234145.1005829-1-jsnow@redhat.com

Maintainers: Thomas Huth <thuth@redhat.com>, Leif Lindholm <leif@nuviainc.com>, Markus Armbruster <armbru@redhat.com>, Tyrone Ting <kfting@nuvoton.com>, Eric Blake <eblake@redhat.com>, "Alex Bennée" <alex.bennee@linaro.org>, Juan Quintela <quintela@redhat.com>, Peter Maydell <peter.maydell@linaro.org>, "Dr. David Alan Gilbert" <dgilbert@redhat.com>, Havard Skinnemoen <hskinnemoen@google.com>, Radoslaw Biernacki <rad@semihalf.com>, Cornelia Huck <cohuck@redhat.com>

docs/conf.py                           |   6 +-
docs/devel/build-system.rst            | 148 ++++++++++++-------------
docs/devel/index.rst                   |   1 +
docs/devel/migration.rst               |  59 +++++-----
docs/devel/python/index.rst            |   7 ++
docs/devel/python/qapi.commands.rst    |   7 ++
docs/devel/python/qapi.common.rst      |   7 ++
docs/devel/python/qapi.error.rst       |   7 ++
docs/devel/python/qapi.events.rst      |   7 ++
docs/devel/python/qapi.expr.rst        |   7 ++
docs/devel/python/qapi.gen.rst         |   7 ++
docs/devel/python/qapi.introspect.rst  |   7 ++
docs/devel/python/qapi.main.rst        |   7 ++
docs/devel/python/qapi.parser.rst      |   8 ++
docs/devel/python/qapi.rst             |  26 +++++
docs/devel/python/qapi.schema.rst      |   7 ++
docs/devel/python/qapi.source.rst      |   7 ++
docs/devel/python/qapi.types.rst       |   7 ++
docs/devel/python/qapi.visit.rst       |   7 ++
docs/devel/tcg-plugins.rst             |  14 +--
docs/devel/testing.rst                 |   2 +-
docs/interop/live-block-operations.rst |   4 +-
docs/system/arm/cpu-features.rst       | 110 +++++++++---------
docs/system/arm/nuvoton.rst            |   2 +-
docs/system/arm/sbsa.rst               |   4 +-
docs/system/cpu-hotplug.rst            |   2 +-
docs/system/s390x/protvirt.rst         |  10 +-
qapi/block-core.json                   |   4 +-
28 files changed, 312 insertions(+), 179 deletions(-)
create mode 100644 docs/devel/python/index.rst
create mode 100644 docs/devel/python/qapi.commands.rst
create mode 100644 docs/devel/python/qapi.common.rst
create mode 100644 docs/devel/python/qapi.error.rst
create mode 100644 docs/devel/python/qapi.events.rst
create mode 100644 docs/devel/python/qapi.expr.rst
create mode 100644 docs/devel/python/qapi.gen.rst
create mode 100644 docs/devel/python/qapi.introspect.rst
create mode 100644 docs/devel/python/qapi.main.rst
create mode 100644 docs/devel/python/qapi.parser.rst
create mode 100644 docs/devel/python/qapi.rst
create mode 100644 docs/devel/python/qapi.schema.rst
create mode 100644 docs/devel/python/qapi.source.rst
create mode 100644 docs/devel/python/qapi.types.rst
create mode 100644 docs/devel/python/qapi.visit.rst

Expand all Fold all

[PATCH 0/3] qapi: sphinx-autodoc for qapi module

Posted by John Snow 4 years, 11 months ago

Merely a testing pre-requisite to prove consistency for docstrings in
QAPI refactors, not intended for review or merge.

John Snow (3):
  [DO-NOT-MERGE] docs: replace single backtick (`) with double-backtick
    (``)
  [DO-NOT-MERGE] docs/sphinx: change default role to "any"
  [DO-NOT-MERGE] docs: enable sphinx-autodoc for scripts/qapi

 docs/conf.py                           |   6 +-
 docs/devel/build-system.rst            | 148 ++++++++++++-------------
 docs/devel/index.rst                   |   1 +
 docs/devel/migration.rst               |  59 +++++-----
 docs/devel/python/index.rst            |   7 ++
 docs/devel/python/qapi.commands.rst    |   7 ++
 docs/devel/python/qapi.common.rst      |   7 ++
 docs/devel/python/qapi.error.rst       |   7 ++
 docs/devel/python/qapi.events.rst      |   7 ++
 docs/devel/python/qapi.expr.rst        |   7 ++
 docs/devel/python/qapi.gen.rst         |   7 ++
 docs/devel/python/qapi.introspect.rst  |   7 ++
 docs/devel/python/qapi.main.rst        |   7 ++
 docs/devel/python/qapi.parser.rst      |   8 ++
 docs/devel/python/qapi.rst             |  26 +++++
 docs/devel/python/qapi.schema.rst      |   7 ++
 docs/devel/python/qapi.source.rst      |   7 ++
 docs/devel/python/qapi.types.rst       |   7 ++
 docs/devel/python/qapi.visit.rst       |   7 ++
 docs/devel/tcg-plugins.rst             |  14 +--
 docs/devel/testing.rst                 |   2 +-
 docs/interop/live-block-operations.rst |   4 +-
 docs/system/arm/cpu-features.rst       | 110 +++++++++---------
 docs/system/arm/nuvoton.rst            |   2 +-
 docs/system/arm/sbsa.rst               |   4 +-
 docs/system/cpu-hotplug.rst            |   2 +-
 docs/system/s390x/protvirt.rst         |  10 +-
 qapi/block-core.json                   |   4 +-
 28 files changed, 312 insertions(+), 179 deletions(-)
 create mode 100644 docs/devel/python/index.rst
 create mode 100644 docs/devel/python/qapi.commands.rst
 create mode 100644 docs/devel/python/qapi.common.rst
 create mode 100644 docs/devel/python/qapi.error.rst
 create mode 100644 docs/devel/python/qapi.events.rst
 create mode 100644 docs/devel/python/qapi.expr.rst
 create mode 100644 docs/devel/python/qapi.gen.rst
 create mode 100644 docs/devel/python/qapi.introspect.rst
 create mode 100644 docs/devel/python/qapi.main.rst
 create mode 100644 docs/devel/python/qapi.parser.rst
 create mode 100644 docs/devel/python/qapi.rst
 create mode 100644 docs/devel/python/qapi.schema.rst
 create mode 100644 docs/devel/python/qapi.source.rst
 create mode 100644 docs/devel/python/qapi.types.rst
 create mode 100644 docs/devel/python/qapi.visit.rst

-- 
2.26.2