Change the configuration for the generated apidoc stubs.
Some of the changes, as a summary:
- Collapse the hierarchy to omit the QEMU namespace page
- Add more meaningful titles to the subpackages
- Prefer source ordering in most places
- Do not index pages that do not define their own symbols (via __all__)
- Show hidden members for qemu.aqmp.protocol, since this interface is
designed to be extended.
Signed-off-by: John Snow <js...@redhat.com>
---
docs/index.rst | 6 +++---
docs/qemu.qmp.aqmp_tui.rst | 7 -------
docs/qemu.qmp.error.rst | 1 +
docs/qemu.qmp.message.rst | 1 +
docs/qemu.qmp.models.rst | 1 +
docs/qemu.qmp.protocol.rst | 2 ++
docs/qemu.qmp.qmp_client.rst | 1 +
docs/qemu.qmp.qmp_shell.rst | 7 -------
docs/qemu.qmp.rst | 8 ++++----
docs/qemu.qmp.util.rst | 1 +
docs/qemu.rst | 10 ----------
11 files changed, 14 insertions(+), 31 deletions(-)
delete mode 100644 docs/qemu.qmp.aqmp_tui.rst
delete mode 100644 docs/qemu.qmp.qmp_shell.rst
delete mode 100644 docs/qemu.rst
diff --git a/docs/index.rst b/docs/index.rst
index bff786a..2c7ccdb 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -3,14 +3,14 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
-Welcome to qemu's documentation!
-================================
+qemu.qmp library documentation
+==============================
.. toctree::
:maxdepth: 4
:caption: Contents:
- qemu
+ qemu.qmp
Indices and tables
diff --git a/docs/qemu.qmp.aqmp_tui.rst b/docs/qemu.qmp.aqmp_tui.rst
deleted file mode 100644
index a5c55f9..0000000
--- a/docs/qemu.qmp.aqmp_tui.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-qemu.qmp.aqmp\_tui module
-=========================
-
-.. automodule:: qemu.qmp.aqmp_tui
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/docs/qemu.qmp.error.rst b/docs/qemu.qmp.error.rst
index 89f069d..5105330 100644
--- a/docs/qemu.qmp.error.rst
+++ b/docs/qemu.qmp.error.rst
@@ -5,3 +5,4 @@ qemu.qmp.error module
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
diff --git a/docs/qemu.qmp.message.rst b/docs/qemu.qmp.message.rst
index 765ae63..b824dc6 100644
--- a/docs/qemu.qmp.message.rst
+++ b/docs/qemu.qmp.message.rst
@@ -5,3 +5,4 @@ qemu.qmp.message module
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
diff --git a/docs/qemu.qmp.models.rst b/docs/qemu.qmp.models.rst
index 55585b7..1e2f608 100644
--- a/docs/qemu.qmp.models.rst
+++ b/docs/qemu.qmp.models.rst
@@ -5,3 +5,4 @@ qemu.qmp.models module
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
diff --git a/docs/qemu.qmp.protocol.rst b/docs/qemu.qmp.protocol.rst
index fca55ad..947e15f 100644
--- a/docs/qemu.qmp.protocol.rst
+++ b/docs/qemu.qmp.protocol.rst
@@ -5,3 +5,5 @@ qemu.qmp.protocol module
:members:
:undoc-members:
:show-inheritance:
+ :private-members:
+ :member-order: bysource
diff --git a/docs/qemu.qmp.qmp_client.rst b/docs/qemu.qmp.qmp_client.rst
index 1d5beda..83b8101 100644
--- a/docs/qemu.qmp.qmp_client.rst
+++ b/docs/qemu.qmp.qmp_client.rst
@@ -5,3 +5,4 @@ qemu.qmp.qmp\_client module
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
diff --git a/docs/qemu.qmp.qmp_shell.rst b/docs/qemu.qmp.qmp_shell.rst
deleted file mode 100644
index 0510cd3..0000000
--- a/docs/qemu.qmp.qmp_shell.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-qemu.qmp.qmp\_shell module
-==========================
-
-.. automodule:: qemu.qmp.qmp_shell
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/docs/qemu.qmp.rst b/docs/qemu.qmp.rst
index 305e5b0..d1d2cd3 100644
--- a/docs/qemu.qmp.rst
+++ b/docs/qemu.qmp.rst
@@ -1,10 +1,12 @@
-qemu.qmp package
-================
+qemu.qmp - Asynchronous QEMU Monitor Protocol (QMP) library
+===========================================================
.. automodule:: qemu.qmp
:members:
:undoc-members:
:show-inheritance:
+ :noindex:
+ :member-order: bysource
Submodules
----------
@@ -12,7 +14,6 @@ Submodules
.. toctree::
:maxdepth: 4
- qemu.qmp.aqmp_tui
qemu.qmp.error
qemu.qmp.events
qemu.qmp.legacy
@@ -20,5 +21,4 @@ Submodules
qemu.qmp.models
qemu.qmp.protocol
qemu.qmp.qmp_client
- qemu.qmp.qmp_shell
qemu.qmp.util
diff --git a/docs/qemu.qmp.util.rst b/docs/qemu.qmp.util.rst
index 8f2ac87..24a6f82 100644
--- a/docs/qemu.qmp.util.rst
+++ b/docs/qemu.qmp.util.rst
@@ -5,3 +5,4 @@ qemu.qmp.util module
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
diff --git a/docs/qemu.rst b/docs/qemu.rst
deleted file mode 100644
index f33a4f4..0000000
--- a/docs/qemu.rst
+++ /dev/null
@@ -1,10 +0,0 @@
-qemu namespace
-==============
-
-Subpackages
------------
-
-.. toctree::
- :maxdepth: 4
-
- qemu.qmp
--
2.31.1
