From b9559eccf8fd3c03b7866de79a3c5d57bcd50a21 Mon Sep 17 00:00:00 2001 From: Jonathan Holloway Date: Tue, 29 Nov 2016 20:43:41 -0600 Subject: docs: initial sphinx setup Change-Id: Ibeac5bba6423cbf93577d8d11cc8f3540e900a5a Signed-off-by: Jonathan Holloway --- docs/source/glustolibs.gluster.rst | 166 +++++++++++++++++++++++++++++++++++++ docs/source/glustolibs.rst | 17 ++++ docs/source/modules.rst | 8 ++ docs/source/setup.rst | 7 ++ 4 files changed, 198 insertions(+) create mode 100644 docs/source/glustolibs.gluster.rst create mode 100644 docs/source/glustolibs.rst create mode 100644 docs/source/modules.rst create mode 100644 docs/source/setup.rst (limited to 'docs/source') diff --git a/docs/source/glustolibs.gluster.rst b/docs/source/glustolibs.gluster.rst new file mode 100644 index 000000000..00fec031e --- /dev/null +++ b/docs/source/glustolibs.gluster.rst @@ -0,0 +1,166 @@ +glustolibs.gluster package +========================== + +Submodules +---------- + +glustolibs.gluster.bitrot_ops module +------------------------------------ + +.. automodule:: glustolibs.gluster.bitrot_ops + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.brick_libs module +------------------------------------ + +.. automodule:: glustolibs.gluster.brick_libs + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.brick_ops module +----------------------------------- + +.. automodule:: glustolibs.gluster.brick_ops + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.gluster_base_class module +-------------------------------------------- + +.. automodule:: glustolibs.gluster.gluster_base_class + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.gluster_init module +-------------------------------------- + +.. automodule:: glustolibs.gluster.gluster_init + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.heal_libs module +----------------------------------- + +.. automodule:: glustolibs.gluster.heal_libs + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.heal_ops module +---------------------------------- + +.. automodule:: glustolibs.gluster.heal_ops + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.lib_utils module +----------------------------------- + +.. automodule:: glustolibs.gluster.lib_utils + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.mount_ops module +----------------------------------- + +.. automodule:: glustolibs.gluster.mount_ops + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.peer_ops module +---------------------------------- + +.. automodule:: glustolibs.gluster.peer_ops + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.quota_ops module +----------------------------------- + +.. automodule:: glustolibs.gluster.quota_ops + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.rebalance_ops module +--------------------------------------- + +.. automodule:: glustolibs.gluster.rebalance_ops + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.samba_ops module +----------------------------------- + +.. automodule:: glustolibs.gluster.samba_ops + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.snap_ops module +---------------------------------- + +.. automodule:: glustolibs.gluster.snap_ops + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.tiering_ops module +------------------------------------- + +.. automodule:: glustolibs.gluster.tiering_ops + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.uss_ops module +--------------------------------- + +.. automodule:: glustolibs.gluster.uss_ops + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.volume_libs module +------------------------------------- + +.. automodule:: glustolibs.gluster.volume_libs + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.volume_ops module +------------------------------------ + +.. automodule:: glustolibs.gluster.volume_ops + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.windows_libs module +-------------------------------------- + +.. automodule:: glustolibs.gluster.windows_libs + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: glustolibs.gluster + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/glustolibs.rst b/docs/source/glustolibs.rst new file mode 100644 index 000000000..127464972 --- /dev/null +++ b/docs/source/glustolibs.rst @@ -0,0 +1,17 @@ +glustolibs package +================== + +Subpackages +----------- + +.. toctree:: + + glustolibs.gluster + +Module contents +--------------- + +.. automodule:: glustolibs + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 000000000..376c632dd --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,8 @@ +glustolibs-gluster +================== + +.. toctree:: + :maxdepth: 4 + + glustolibs + setup diff --git a/docs/source/setup.rst b/docs/source/setup.rst new file mode 100644 index 000000000..31789b12b --- /dev/null +++ b/docs/source/setup.rst @@ -0,0 +1,7 @@ +setup module +============ + +.. automodule:: setup + :members: + :undoc-members: + :show-inheritance: -- cgit