updated documentation

* documentation reviewed after rewrite, ready for 0.2.1
* updated docstrings format to fit sphinx autodoc

10 files changed, 317 insertions, 0 deletions

diff --git a/docs/api/leap.config.rst b/docs/api/leap.config.rst
new file mode 100644
index 00000000..c1462817
--- /dev/null
+++ b/docs/api/leap.config.rst
@@ -0,0 +1,27 @@
+config Package
+==============
+
+:mod:`leapsettings` Module
+--------------------------
+
+.. automodule:: leap.config.leapsettings
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`provider_spec` Module
+---------------------------
+
+.. automodule:: leap.config.provider_spec
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`providerconfig` Module
+----------------------------
+
+.. automodule:: leap.config.providerconfig
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/api/leap.crypto.rst b/docs/api/leap.crypto.rst
new file mode 100644
index 00000000..6db77e86
--- /dev/null
+++ b/docs/api/leap.crypto.rst
@@ -0,0 +1,34 @@
+crypto Package
+==============
+
+:mod:`constants` Module
+-----------------------
+
+.. automodule:: leap.crypto.constants
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`srpauth` Module
+---------------------
+
+.. automodule:: leap.crypto.srpauth
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`srpregister` Module
+-------------------------
+
+.. automodule:: leap.crypto.srpregister
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+    leap.crypto.tests
+
diff --git a/docs/api/leap.crypto.tests.rst b/docs/api/leap.crypto.tests.rst
new file mode 100644
index 00000000..f9e32580
--- /dev/null
+++ b/docs/api/leap.crypto.tests.rst
@@ -0,0 +1,27 @@
+tests Package
+=============
+
+:mod:`tests` Package
+--------------------
+
+.. automodule:: leap.crypto.tests
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`fake_provider` Module
+---------------------------
+
+.. automodule:: leap.crypto.tests.fake_provider
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_srpregister` Module
+------------------------------
+
+.. automodule:: leap.crypto.tests.test_srpregister
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/api/leap.gui.rst b/docs/api/leap.gui.rst
new file mode 100644
index 00000000..1559e079
--- /dev/null
+++ b/docs/api/leap.gui.rst
@@ -0,0 +1,59 @@
+gui Package
+===========
+
+:mod:`locale_rc` Module
+-----------------------
+
+.. automodule:: leap.gui.locale_rc
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`mainwindow` Module
+------------------------
+
+.. automodule:: leap.gui.mainwindow
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`mainwindow_rc` Module
+---------------------------
+
+.. automodule:: leap.gui.mainwindow_rc
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`ui_mainwindow` Module
+---------------------------
+
+.. automodule:: leap.gui.ui_mainwindow
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`ui_wizard` Module
+-----------------------
+
+.. automodule:: leap.gui.ui_wizard
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`wizard` Module
+--------------------
+
+.. automodule:: leap.gui.wizard
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`wizardpage` Module
+------------------------
+
+.. automodule:: leap.gui.wizardpage
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/api/leap.platform_init.rst b/docs/api/leap.platform_init.rst
new file mode 100644
index 00000000..a638df35
--- /dev/null
+++ b/docs/api/leap.platform_init.rst
@@ -0,0 +1,27 @@
+platform_init Package
+=====================
+
+:mod:`platform_init` Package
+----------------------------
+
+.. automodule:: leap.platform_init
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`initializers` Module
+--------------------------
+
+.. automodule:: leap.platform_init.initializers
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`locks` Module
+-------------------
+
+.. automodule:: leap.platform_init.locks
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/api/leap.rst b/docs/api/leap.rst
new file mode 100644
index 00000000..0f03c9e4
--- /dev/null
+++ b/docs/api/leap.rst
@@ -0,0 +1,24 @@
+leap Package
+============
+
+:mod:`leap` Package
+-------------------
+
+.. automodule:: leap
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Subpackages
+-----------
+
+.. toctree::
+
+    leap.config
+    leap.crypto
+    leap.gui
+    leap.platform_init
+    leap.services
+    leap.util
+
diff --git a/docs/api/leap.services.eip.rst b/docs/api/leap.services.eip.rst
new file mode 100644
index 00000000..0cf489cf
--- /dev/null
+++ b/docs/api/leap.services.eip.rst
@@ -0,0 +1,59 @@
+eip Package
+===========
+
+:mod:`eipbootstrapper` Module
+-----------------------------
+
+.. automodule:: leap.services.eip.eipbootstrapper
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`eipconfig` Module
+-----------------------
+
+.. automodule:: leap.services.eip.eipconfig
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`eipspec` Module
+---------------------
+
+.. automodule:: leap.services.eip.eipspec
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`providerbootstrapper` Module
+----------------------------------
+
+.. automodule:: leap.services.eip.providerbootstrapper
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`udstelnet` Module
+-----------------------
+
+.. automodule:: leap.services.eip.udstelnet
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`vpn` Module
+-----------------
+
+.. automodule:: leap.services.eip.vpn
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`vpnlaunchers` Module
+--------------------------
+
+.. automodule:: leap.services.eip.vpnlaunchers
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/api/leap.services.rst b/docs/api/leap.services.rst
new file mode 100644
index 00000000..1a35ab5b
--- /dev/null
+++ b/docs/api/leap.services.rst
@@ -0,0 +1,10 @@
+services Package
+================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    leap.services.eip
+
diff --git a/docs/api/leap.util.rst b/docs/api/leap.util.rst
new file mode 100644
index 00000000..85eb79da
--- /dev/null
+++ b/docs/api/leap.util.rst
@@ -0,0 +1,43 @@
+util Package
+============
+
+:mod:`util` Package
+-------------------
+
+.. automodule:: leap.util
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`checkerthread` Module
+---------------------------
+
+.. automodule:: leap.util.checkerthread
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`leap_argparse` Module
+---------------------------
+
+.. automodule:: leap.util.leap_argparse
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`privilege_policies` Module
+--------------------------------
+
+.. automodule:: leap.util.privilege_policies
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`request_helpers` Module
+-----------------------------
+
+.. automodule:: leap.util.request_helpers
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/api/modules.rst b/docs/api/modules.rst
new file mode 100644
index 00000000..d49776ae
--- /dev/null
+++ b/docs/api/modules.rst
@@ -0,0 +1,7 @@
+leap
+====
+
+.. toctree::
+   :maxdepth: 4
+
+   leap