[tor-commits] [ooni-probe/master] Add docs for modules, kit and lib

[art at torproject.org]

commit 135bfd2e2414c23ce8e34681a98d1a8b36efc112
Author: Arturo Filastò <arturo at filasto.net>
Date:   Tue Nov 6 22:37:00 2012 +0100

    Add docs for modules, kit and lib
---
 docs/source/api/modules.rst  |    7 +++++++
 docs/source/api/ooni.kit.rst |   19 +++++++++++++++++++
 docs/source/api/ooni.lib.rst |   36 ++++++++++++++++++++++++++++++++++++
 3 files changed, 62 insertions(+), 0 deletions(-)

diff --git a/docs/source/api/modules.rst b/docs/source/api/modules.rst
new file mode 100644
index 0000000..a9f85c8
--- /dev/null
+++ b/docs/source/api/modules.rst
@@ -0,0 +1,7 @@
+ooni
+====
+
+.. toctree::
+   :maxdepth: 4
+
+   ooni
diff --git a/docs/source/api/ooni.kit.rst b/docs/source/api/ooni.kit.rst
new file mode 100644
index 0000000..d870355
--- /dev/null
+++ b/docs/source/api/ooni.kit.rst
@@ -0,0 +1,19 @@
+kit Package
+===========
+
+:mod:`kit` Package
+------------------
+
+.. automodule:: ooni.kit
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`domclass` Module
+----------------------
+
+.. automodule:: ooni.kit.domclass
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/source/api/ooni.lib.rst b/docs/source/api/ooni.lib.rst
new file mode 100644
index 0000000..2711370
--- /dev/null
+++ b/docs/source/api/ooni.lib.rst
@@ -0,0 +1,36 @@
+lib Package
+===========
+
+:mod:`lib` Package
+------------------
+
+.. automodule:: ooni.lib
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`rfc3339` Module
+---------------------
+
+.. automodule:: ooni.lib.rfc3339
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`txscapy` Module
+---------------------
+
+.. automodule:: ooni.lib.txscapy
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`txtraceroute` Module
+--------------------------
+
+.. automodule:: ooni.lib.txtraceroute
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+