[PATCH 2/6] Order module members by position in source instead of alphabetically.
David Lehman
dlehman at redhat.com
Wed Jul 23 19:23:59 UTC 2014
sphinx-apidocs does not provide any way to specify global options (eg:
autodoc_member_order), nor is it currently possible to specify automodule
options that take values via SPHINX_APIDOC_OPTIONS.
---
doc/blivet.devicelibs.rst | 11 +++++++++++
doc/blivet.formats.rst | 13 +++++++++++++
doc/blivet.rst | 21 +++++++++++++++++++++
doc/modules.rst | 4 ++--
4 files changed, 47 insertions(+), 2 deletions(-)
diff --git a/doc/blivet.devicelibs.rst b/doc/blivet.devicelibs.rst
index 44ca8b5..1fcce0c 100644
--- a/doc/blivet.devicelibs.rst
+++ b/doc/blivet.devicelibs.rst
@@ -8,6 +8,7 @@ devicelibs Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`crypto` Module
--------------------
@@ -16,6 +17,7 @@ devicelibs Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`dasd` Module
------------------
@@ -24,6 +26,7 @@ devicelibs Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`dm` Module
----------------
@@ -32,6 +35,7 @@ devicelibs Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`edd` Module
-----------------
@@ -40,6 +44,7 @@ devicelibs Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`loop` Module
------------------
@@ -48,6 +53,7 @@ devicelibs Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`lvm` Module
-----------------
@@ -56,6 +62,7 @@ devicelibs Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`mdraid` Module
--------------------
@@ -64,6 +71,7 @@ devicelibs Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`mpath` Module
-------------------
@@ -72,6 +80,7 @@ devicelibs Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`raid` Module
------------------
@@ -80,6 +89,7 @@ devicelibs Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`swap` Module
------------------
@@ -88,4 +98,5 @@ devicelibs Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
diff --git a/doc/blivet.formats.rst b/doc/blivet.formats.rst
index 7a00a25..6a900f4 100644
--- a/doc/blivet.formats.rst
+++ b/doc/blivet.formats.rst
@@ -8,6 +8,7 @@ formats Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`biosboot` Module
----------------------
@@ -16,6 +17,7 @@ formats Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`disklabel` Module
-----------------------
@@ -24,6 +26,7 @@ formats Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`dmraid` Module
--------------------
@@ -32,6 +35,7 @@ formats Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`fs` Module
----------------
@@ -40,6 +44,7 @@ formats Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`fslabel` Module
---------------------
@@ -48,6 +53,7 @@ formats Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`fslabeling` Module
------------------------
@@ -56,6 +62,7 @@ formats Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`luks` Module
------------------
@@ -64,6 +71,7 @@ formats Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`lvmpv` Module
-------------------
@@ -72,6 +80,7 @@ formats Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`mdraid` Module
--------------------
@@ -80,6 +89,7 @@ formats Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`multipath` Module
-----------------------
@@ -88,6 +98,7 @@ formats Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`prepboot` Module
----------------------
@@ -96,6 +107,7 @@ formats Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`swap` Module
------------------
@@ -104,4 +116,5 @@ formats Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
diff --git a/doc/blivet.rst b/doc/blivet.rst
index ed79389..92ca5a6 100644
--- a/doc/blivet.rst
+++ b/doc/blivet.rst
@@ -8,6 +8,7 @@ blivet Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`arch` Module
------------------
@@ -16,6 +17,7 @@ blivet Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`deviceaction` Module
--------------------------
@@ -24,6 +26,7 @@ blivet Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`devicefactory` Module
---------------------------
@@ -32,6 +35,7 @@ blivet Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`devices` Module
---------------------
@@ -40,6 +44,7 @@ blivet Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`devicetree` Module
------------------------
@@ -48,6 +53,7 @@ blivet Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`errors` Module
--------------------
@@ -56,6 +62,7 @@ blivet Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`fcoe` Module
------------------
@@ -64,6 +71,7 @@ blivet Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`flags` Module
-------------------
@@ -72,6 +80,7 @@ blivet Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`i18n` Module
------------------
@@ -80,6 +89,7 @@ blivet Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`iscsi` Module
-------------------
@@ -88,6 +98,7 @@ blivet Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`partitioning` Module
--------------------------
@@ -96,6 +107,7 @@ blivet Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`partspec` Module
----------------------
@@ -104,6 +116,7 @@ blivet Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`platform` Module
----------------------
@@ -112,6 +125,7 @@ blivet Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`pyudev` Module
--------------------
@@ -120,6 +134,7 @@ blivet Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`size` Module
------------------
@@ -128,6 +143,7 @@ blivet Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`storage_log` Module
-------------------------
@@ -136,6 +152,7 @@ blivet Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`tsort` Module
-------------------
@@ -144,6 +161,7 @@ blivet Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`udev` Module
------------------
@@ -152,6 +170,7 @@ blivet Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`util` Module
------------------
@@ -160,6 +179,7 @@ blivet Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
:mod:`zfcp` Module
------------------
@@ -168,6 +188,7 @@ blivet Package
:members:
:undoc-members:
:show-inheritance:
+ :member-order: bysource
Subpackages
-----------
diff --git a/doc/modules.rst b/doc/modules.rst
index ca9d073..07803ac 100644
--- a/doc/modules.rst
+++ b/doc/modules.rst
@@ -1,5 +1,5 @@
-API
-===
+blivet
+======
.. toctree::
:maxdepth: 4
--
1.9.3
More information about the anaconda-patches
mailing list