[tor-commits] [ooni-probe/master] Add documentation on the OONI API

[isis at torproject.org]

commit d01d501efe93a9672d37b9aa0dae61e0d3065106
Author: Arturo Filastò <arturo at filasto.net>
Date:   Fri Sep 28 14:41:21 2012 +0000

    Add documentation on the OONI API
---
 docs/source/api/ooni.rst           |   60 ++++++++++++++++++++++++++++++++++++
 docs/source/api/ooni.templates.rst |   11 ++++++
 docs/source/api/ooni.utils.rst     |   51 ++++++++++++++++++++++++++++++
 docs/source/index.rst              |    1 +
 4 files changed, 123 insertions(+), 0 deletions(-)

diff --git a/docs/source/api/ooni.rst b/docs/source/api/ooni.rst
new file mode 100644
index 0000000..bcdd402
--- /dev/null
+++ b/docs/source/api/ooni.rst
@@ -0,0 +1,60 @@
+ooni Package
+============
+
+:mod:`ooni` Package
+-------------------
+
+.. automodule:: ooni.__init__
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`input` Module
+-------------------
+
+.. automodule:: ooni.input
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`nettest` Module
+---------------------
+
+.. automodule:: ooni.nettest
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`oonicli` Module
+---------------------
+
+.. automodule:: ooni.oonicli
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`reporter` Module
+----------------------
+
+.. automodule:: ooni.reporter
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`runner` Module
+--------------------
+
+.. automodule:: ooni.runner
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+    ooni.lib
+    ooni.templates
+    ooni.utils
+
diff --git a/docs/source/api/ooni.templates.rst b/docs/source/api/ooni.templates.rst
new file mode 100644
index 0000000..662da1d
--- /dev/null
+++ b/docs/source/api/ooni.templates.rst
@@ -0,0 +1,11 @@
+templates Package
+=================
+
+:mod:`http` Module
+------------------
+
+.. automodule:: ooni.templates.http
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/source/api/ooni.utils.rst b/docs/source/api/ooni.utils.rst
new file mode 100644
index 0000000..5361b43
--- /dev/null
+++ b/docs/source/api/ooni.utils.rst
@@ -0,0 +1,51 @@
+utils Package
+=============
+
+:mod:`utils` Package
+--------------------
+
+.. automodule:: ooni.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`config` Module
+--------------------
+
+.. automodule:: ooni.utils.config
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`date` Module
+------------------
+
+.. automodule:: ooni.utils.date
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`log` Module
+-----------------
+
+.. automodule:: ooni.utils.log
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`logo` Module
+------------------
+
+.. automodule:: ooni.utils.logo
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`net` Module
+-----------------
+
+.. automodule:: ooni.utils.net
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 34ca87c..e744f7f 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -46,5 +46,6 @@ Contents
     install
     tutorial
     writing_tests
+    api/*