[Pkg-privacy-commits] [onionbalance] 22/117: Update documenation, split modules as separate files

[Donncha O'Cearbahill]

This is an automated email from the git hooks/post-receive script.

donncha-guest pushed a commit to branch debian/sid
in repository onionbalance.

commit b01aa0358d77f1b11f89f1b22ca0e410eeede8a3
Author: Donncha O'Cearbhaill <donncha at donncha.is>
Date:   Wed Jun 17 15:20:40 2015 +0100

    Update documenation, split modules as separate files
---
 docs/design.rst                    |  2 +-
 docs/modules.rst                   |  7 ++++
 docs/onionbalance.config.rst       |  7 ++++
 docs/onionbalance.descriptor.rst   |  7 ++++
 docs/onionbalance.eventhandler.rst |  7 ++++
 docs/onionbalance.instance.rst     |  7 ++++
 docs/onionbalance.log.rst          |  7 ++++
 docs/onionbalance.manager.rst      |  7 ++++
 docs/onionbalance.rst              | 66 ++++++--------------------------------
 docs/onionbalance.service.rst      |  7 ++++
 docs/onionbalance.util.rst         |  7 ++++
 11 files changed, 74 insertions(+), 57 deletions(-)

diff --git a/docs/design.rst b/docs/design.rst
index cd542db..84e9179 100644
--- a/docs/design.rst
+++ b/docs/design.rst
@@ -81,7 +81,7 @@ system, it should before a number of checks to ensure that it is valid:
    included in the master descriptor.
 
 It should be possible for two or more independent management servers to
-publish descriptors for a single onion service. The servers woulds
+publish descriptors for a single onion service. The servers would
 publish independent descriptors which will replace each other on the
 HSDir system.. Any difference in introduction point selection between
 descriptors should not impact the end user.
diff --git a/docs/modules.rst b/docs/modules.rst
new file mode 100644
index 0000000..3b162c7
--- /dev/null
+++ b/docs/modules.rst
@@ -0,0 +1,7 @@
+onionbalance
+============
+
+.. toctree::
+   :maxdepth: 4
+
+   onionbalance
diff --git a/docs/onionbalance.config.rst b/docs/onionbalance.config.rst
new file mode 100644
index 0000000..bf11771
--- /dev/null
+++ b/docs/onionbalance.config.rst
@@ -0,0 +1,7 @@
+onionbalance.config module
+==========================
+
+.. automodule:: onionbalance.config
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/onionbalance.descriptor.rst b/docs/onionbalance.descriptor.rst
new file mode 100644
index 0000000..9e8b911
--- /dev/null
+++ b/docs/onionbalance.descriptor.rst
@@ -0,0 +1,7 @@
+onionbalance.descriptor module
+==============================
+
+.. automodule:: onionbalance.descriptor
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/onionbalance.eventhandler.rst b/docs/onionbalance.eventhandler.rst
new file mode 100644
index 0000000..41007bb
--- /dev/null
+++ b/docs/onionbalance.eventhandler.rst
@@ -0,0 +1,7 @@
+onionbalance.eventhandler module
+================================
+
+.. automodule:: onionbalance.eventhandler
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/onionbalance.instance.rst b/docs/onionbalance.instance.rst
new file mode 100644
index 0000000..37c5cbd
--- /dev/null
+++ b/docs/onionbalance.instance.rst
@@ -0,0 +1,7 @@
+onionbalance.instance module
+============================
+
+.. automodule:: onionbalance.instance
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/onionbalance.log.rst b/docs/onionbalance.log.rst
new file mode 100644
index 0000000..852f459
--- /dev/null
+++ b/docs/onionbalance.log.rst
@@ -0,0 +1,7 @@
+onionbalance.log module
+=======================
+
+.. automodule:: onionbalance.log
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/onionbalance.manager.rst b/docs/onionbalance.manager.rst
new file mode 100644
index 0000000..a75460e
--- /dev/null
+++ b/docs/onionbalance.manager.rst
@@ -0,0 +1,7 @@
+onionbalance.manager module
+===========================
+
+.. automodule:: onionbalance.manager
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/onionbalance.rst b/docs/onionbalance.rst
index 8418ffc..8c8e44b 100644
--- a/docs/onionbalance.rst
+++ b/docs/onionbalance.rst
@@ -1,65 +1,19 @@
-OnionBalance package
+onionbalance package
 ====================
 
 Submodules
 ----------
 
-onionbalance.config module
---------------------------
-
-.. automodule:: onionbalance.config
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-onionbalance.descriptor module
-------------------------------
-
-.. automodule:: onionbalance.descriptor
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-onionbalance.eventhandler module
---------------------------------
-
-.. automodule:: onionbalance.eventhandler
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-onionbalance.hiddenservice module
----------------------------------
-
-.. automodule:: onionbalance.hiddenservice
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-onionbalance.log module
------------------------
-
-.. automodule:: onionbalance.log
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-onionbalance.manager module
----------------------------
-
-.. automodule:: onionbalance.manager
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-onionbalance.util module
-------------------------
-
-.. automodule:: onionbalance.util
-    :members:
-    :undoc-members:
-    :show-inheritance:
+.. toctree::
 
+   onionbalance.config
+   onionbalance.descriptor
+   onionbalance.eventhandler
+   onionbalance.instance
+   onionbalance.log
+   onionbalance.manager
+   onionbalance.service
+   onionbalance.util
 
 Module contents
 ---------------
diff --git a/docs/onionbalance.service.rst b/docs/onionbalance.service.rst
new file mode 100644
index 0000000..2265722
--- /dev/null
+++ b/docs/onionbalance.service.rst
@@ -0,0 +1,7 @@
+onionbalance.service module
+===========================
+
+.. automodule:: onionbalance.service
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/onionbalance.util.rst b/docs/onionbalance.util.rst
new file mode 100644
index 0000000..0a96ca4
--- /dev/null
+++ b/docs/onionbalance.util.rst
@@ -0,0 +1,7 @@
+onionbalance.util module
+========================
+
+.. automodule:: onionbalance.util
+    :members:
+    :undoc-members:
+    :show-inheritance:

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-privacy/packages/onionbalance.git