[PATCH 1/6] Add API docs.

David Lehman dlehman at redhat.com
Wed Jul 23 19:23:58 UTC 2014


These were generated using sphinx-apidoc.
---
 .gitignore                |   4 --
 doc/blivet.devicelibs.rst |  91 +++++++++++++++++++++++
 doc/blivet.formats.rst    | 107 +++++++++++++++++++++++++++
 doc/blivet.rst            | 179 ++++++++++++++++++++++++++++++++++++++++++++++
 doc/index.rst             |   2 +-
 doc/modules.rst           |   7 ++
 6 files changed, 385 insertions(+), 5 deletions(-)
 create mode 100644 doc/blivet.devicelibs.rst
 create mode 100644 doc/blivet.formats.rst
 create mode 100644 doc/blivet.rst
 create mode 100644 doc/modules.rst

diff --git a/.gitignore b/.gitignore
index 54c7439..3f37b3b 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,10 +2,6 @@
 .*.swp
 blivet*.tar.gz
 blivet*.tar.bz2
-doc/blivet.devicelibs.rst
-doc/blivet.formats.rst
-doc/blivet.rst
-doc/modules.rst
 doc/_build
 po/*.gmo
 po/*.po
diff --git a/doc/blivet.devicelibs.rst b/doc/blivet.devicelibs.rst
new file mode 100644
index 0000000..44ca8b5
--- /dev/null
+++ b/doc/blivet.devicelibs.rst
@@ -0,0 +1,91 @@
+devicelibs Package
+==================
+
+:mod:`btrfs` Module
+-------------------
+
+.. automodule:: blivet.devicelibs.btrfs
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`crypto` Module
+--------------------
+
+.. automodule:: blivet.devicelibs.crypto
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`dasd` Module
+------------------
+
+.. automodule:: blivet.devicelibs.dasd
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`dm` Module
+----------------
+
+.. automodule:: blivet.devicelibs.dm
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`edd` Module
+-----------------
+
+.. automodule:: blivet.devicelibs.edd
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`loop` Module
+------------------
+
+.. automodule:: blivet.devicelibs.loop
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`lvm` Module
+-----------------
+
+.. automodule:: blivet.devicelibs.lvm
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`mdraid` Module
+--------------------
+
+.. automodule:: blivet.devicelibs.mdraid
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`mpath` Module
+-------------------
+
+.. automodule:: blivet.devicelibs.mpath
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`raid` Module
+------------------
+
+.. automodule:: blivet.devicelibs.raid
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`swap` Module
+------------------
+
+.. automodule:: blivet.devicelibs.swap
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/doc/blivet.formats.rst b/doc/blivet.formats.rst
new file mode 100644
index 0000000..7a00a25
--- /dev/null
+++ b/doc/blivet.formats.rst
@@ -0,0 +1,107 @@
+formats Package
+===============
+
+:mod:`formats` Package
+----------------------
+
+.. automodule:: blivet.formats
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`biosboot` Module
+----------------------
+
+.. automodule:: blivet.formats.biosboot
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`disklabel` Module
+-----------------------
+
+.. automodule:: blivet.formats.disklabel
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`dmraid` Module
+--------------------
+
+.. automodule:: blivet.formats.dmraid
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`fs` Module
+----------------
+
+.. automodule:: blivet.formats.fs
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`fslabel` Module
+---------------------
+
+.. automodule:: blivet.formats.fslabel
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`fslabeling` Module
+------------------------
+
+.. automodule:: blivet.formats.fslabeling
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`luks` Module
+------------------
+
+.. automodule:: blivet.formats.luks
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`lvmpv` Module
+-------------------
+
+.. automodule:: blivet.formats.lvmpv
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`mdraid` Module
+--------------------
+
+.. automodule:: blivet.formats.mdraid
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`multipath` Module
+-----------------------
+
+.. automodule:: blivet.formats.multipath
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`prepboot` Module
+----------------------
+
+.. automodule:: blivet.formats.prepboot
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`swap` Module
+------------------
+
+.. automodule:: blivet.formats.swap
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/doc/blivet.rst b/doc/blivet.rst
new file mode 100644
index 0000000..ed79389
--- /dev/null
+++ b/doc/blivet.rst
@@ -0,0 +1,179 @@
+blivet Package
+==============
+
+:mod:`blivet` Package
+---------------------
+
+.. automodule:: blivet.__init__
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`arch` Module
+------------------
+
+.. automodule:: blivet.arch
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`deviceaction` Module
+--------------------------
+
+.. automodule:: blivet.deviceaction
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`devicefactory` Module
+---------------------------
+
+.. automodule:: blivet.devicefactory
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`devices` Module
+---------------------
+
+.. automodule:: blivet.devices
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`devicetree` Module
+------------------------
+
+.. automodule:: blivet.devicetree
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`errors` Module
+--------------------
+
+.. automodule:: blivet.errors
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`fcoe` Module
+------------------
+
+.. automodule:: blivet.fcoe
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`flags` Module
+-------------------
+
+.. automodule:: blivet.flags
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`i18n` Module
+------------------
+
+.. automodule:: blivet.i18n
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`iscsi` Module
+-------------------
+
+.. automodule:: blivet.iscsi
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`partitioning` Module
+--------------------------
+
+.. automodule:: blivet.partitioning
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`partspec` Module
+----------------------
+
+.. automodule:: blivet.partspec
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`platform` Module
+----------------------
+
+.. automodule:: blivet.platform
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`pyudev` Module
+--------------------
+
+.. automodule:: blivet.pyudev
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`size` Module
+------------------
+
+.. automodule:: blivet.size
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`storage_log` Module
+-------------------------
+
+.. automodule:: blivet.storage_log
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`tsort` Module
+-------------------
+
+.. automodule:: blivet.tsort
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`udev` Module
+------------------
+
+.. automodule:: blivet.udev
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`util` Module
+------------------
+
+.. automodule:: blivet.util
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`zfcp` Module
+------------------
+
+.. automodule:: blivet.zfcp
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+    blivet.devicelibs
+    blivet.formats
+
diff --git a/doc/index.rst b/doc/index.rst
index 8c534ee..5c32438 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -9,7 +9,7 @@ Welcome to Blivet's documentation!
 Contents:
 
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 4
 
    intro
    modules
diff --git a/doc/modules.rst b/doc/modules.rst
new file mode 100644
index 0000000..ca9d073
--- /dev/null
+++ b/doc/modules.rst
@@ -0,0 +1,7 @@
+API
+===
+
+.. toctree::
+   :maxdepth: 4
+
+   blivet
-- 
1.9.3



More information about the anaconda-patches mailing list