included api docs

18 files changed, 792 insertions, 2 deletions

diff --git a/Makefile b/Makefile
index 5bdf9c36..a8859725 100644
--- a/Makefile
+++ b/Makefile
@@ -1,3 +1,4 @@
+SHELL := /bin/zsh
 # ################################
 # Makefile for compiling resources
 # files.
@@ -62,5 +63,8 @@ deb:
 	@git tag -a debian/$(DEBVER) -m "..."
 	@debuild -us -uc -i.git
 
+apidocs:
+	@sphinx-apidoc -o docs/api src/leap
+
 clean : 
 	$(RM) $(COMPILED_UI) $(COMPILED_RESOURCES) $(COMPILED_UI:.py=.pyc) $(COMPILED_RESOURCES:.py=.pyc)  
diff --git a/docs/api/leap.base.rst b/docs/api/leap.base.rst
new file mode 100644
index 00000000..778836c4
--- /dev/null
+++ b/docs/api/leap.base.rst
@@ -0,0 +1,98 @@
+base Package
+============
+
+:mod:`auth` Module
+------------------
+
+.. automodule:: leap.base.auth
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`authentication` Module
+----------------------------
+
+.. automodule:: leap.base.authentication
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`checks` Module
+--------------------
+
+.. automodule:: leap.base.checks
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`config` Module
+--------------------
+
+.. automodule:: leap.base.config
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`connection` Module
+------------------------
+
+.. automodule:: leap.base.connection
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`constants` Module
+-----------------------
+
+.. automodule:: leap.base.constants
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`exceptions` Module
+------------------------
+
+.. automodule:: leap.base.exceptions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`network` Module
+---------------------
+
+.. automodule:: leap.base.network
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`pluggableconfig` Module
+-----------------------------
+
+.. automodule:: leap.base.pluggableconfig
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`providers` Module
+-----------------------
+
+.. automodule:: leap.base.providers
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`specs` Module
+-------------------
+
+.. automodule:: leap.base.specs
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+    leap.base.tests
+
diff --git a/docs/api/leap.base.tests.rst b/docs/api/leap.base.tests.rst
new file mode 100644
index 00000000..7af035b0
--- /dev/null
+++ b/docs/api/leap.base.tests.rst
@@ -0,0 +1,43 @@
+tests Package
+=============
+
+:mod:`test_auth` Module
+-----------------------
+
+.. automodule:: leap.base.tests.test_auth
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_checks` Module
+-------------------------
+
+.. automodule:: leap.base.tests.test_checks
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_config` Module
+-------------------------
+
+.. automodule:: leap.base.tests.test_config
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_providers` Module
+----------------------------
+
+.. automodule:: leap.base.tests.test_providers
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_validation` Module
+-----------------------------
+
+.. automodule:: leap.base.tests.test_validation
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/api/leap.baseapp.rst b/docs/api/leap.baseapp.rst
new file mode 100644
index 00000000..f24b4976
--- /dev/null
+++ b/docs/api/leap.baseapp.rst
@@ -0,0 +1,75 @@
+baseapp Package
+===============
+
+:mod:`constants` Module
+-----------------------
+
+.. automodule:: leap.baseapp.constants
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`dialogs` Module
+---------------------
+
+.. automodule:: leap.baseapp.dialogs
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`eip` Module
+-----------------
+
+.. automodule:: leap.baseapp.eip
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`leap_app` Module
+----------------------
+
+.. automodule:: leap.baseapp.leap_app
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`log` Module
+-----------------
+
+.. automodule:: leap.baseapp.log
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`mainwindow` Module
+------------------------
+
+.. automodule:: leap.baseapp.mainwindow
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`network` Module
+---------------------
+
+.. automodule:: leap.baseapp.network
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`permcheck` Module
+-----------------------
+
+.. automodule:: leap.baseapp.permcheck
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`systray` Module
+---------------------
+
+.. automodule:: leap.baseapp.systray
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/api/leap.certs.rst b/docs/api/leap.certs.rst
new file mode 100644
index 00000000..e9cc2524
--- /dev/null
+++ b/docs/api/leap.certs.rst
@@ -0,0 +1,11 @@
+certs Package
+=============
+
+:mod:`certs` Package
+--------------------
+
+.. automodule:: leap.certs
+    :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..a04e2e1d
--- /dev/null
+++ b/docs/api/leap.crypto.rst
@@ -0,0 +1,26 @@
+crypto Package
+==============
+
+:mod:`certs` Module
+-------------------
+
+.. automodule:: leap.crypto.certs
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`leapkeyring` Module
+-------------------------
+
+.. automodule:: leap.crypto.leapkeyring
+    :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..54ffa62f
--- /dev/null
+++ b/docs/api/leap.crypto.tests.rst
@@ -0,0 +1,11 @@
+tests Package
+=============
+
+:mod:`test_certs` Module
+------------------------
+
+.. automodule:: leap.crypto.tests.test_certs
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/api/leap.eip.rst b/docs/api/leap.eip.rst
new file mode 100644
index 00000000..e418461b
--- /dev/null
+++ b/docs/api/leap.eip.rst
@@ -0,0 +1,74 @@
+eip Package
+===========
+
+:mod:`checks` Module
+--------------------
+
+.. automodule:: leap.eip.checks
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`config` Module
+--------------------
+
+.. automodule:: leap.eip.config
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`constants` Module
+-----------------------
+
+.. automodule:: leap.eip.constants
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`eipconnection` Module
+---------------------------
+
+.. automodule:: leap.eip.eipconnection
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`exceptions` Module
+------------------------
+
+.. automodule:: leap.eip.exceptions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`openvpnconnection` Module
+-------------------------------
+
+.. automodule:: leap.eip.openvpnconnection
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`specs` Module
+-------------------
+
+.. automodule:: leap.eip.specs
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`udstelnet` Module
+-----------------------
+
+.. automodule:: leap.eip.udstelnet
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+    leap.eip.tests
+
diff --git a/docs/api/leap.eip.tests.rst b/docs/api/leap.eip.tests.rst
new file mode 100644
index 00000000..932a074f
--- /dev/null
+++ b/docs/api/leap.eip.tests.rst
@@ -0,0 +1,43 @@
+tests Package
+=============
+
+:mod:`data` Module
+------------------
+
+.. automodule:: leap.eip.tests.data
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_checks` Module
+-------------------------
+
+.. automodule:: leap.eip.tests.test_checks
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_config` Module
+-------------------------
+
+.. automodule:: leap.eip.tests.test_config
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_eipconnection` Module
+--------------------------------
+
+.. automodule:: leap.eip.tests.test_eipconnection
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_openvpnconnection` Module
+------------------------------------
+
+.. automodule:: leap.eip.tests.test_openvpnconnection
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/api/leap.gui.firstrun.rst b/docs/api/leap.gui.firstrun.rst
new file mode 100644
index 00000000..36470c33
--- /dev/null
+++ b/docs/api/leap.gui.firstrun.rst
@@ -0,0 +1,91 @@
+firstrun Package
+================
+
+:mod:`firstrun` Package
+-----------------------
+
+.. automodule:: leap.gui.firstrun
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`intro` Module
+-------------------
+
+.. automodule:: leap.gui.firstrun.intro
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`last` Module
+------------------
+
+.. automodule:: leap.gui.firstrun.last
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`login` Module
+-------------------
+
+.. automodule:: leap.gui.firstrun.login
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`mixins` Module
+--------------------
+
+.. automodule:: leap.gui.firstrun.mixins
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`providerinfo` Module
+--------------------------
+
+.. automodule:: leap.gui.firstrun.providerinfo
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`providerselect` Module
+----------------------------
+
+.. automodule:: leap.gui.firstrun.providerselect
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`providersetup` Module
+---------------------------
+
+.. automodule:: leap.gui.firstrun.providersetup
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`register` Module
+----------------------
+
+.. automodule:: leap.gui.firstrun.register
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`regvalidation` Module
+---------------------------
+
+.. automodule:: leap.gui.firstrun.regvalidation
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`wizard` Module
+--------------------
+
+.. automodule:: leap.gui.firstrun.wizard
+    :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..a35a7856
--- /dev/null
+++ b/docs/api/leap.gui.rst
@@ -0,0 +1,75 @@
+gui Package
+===========
+
+:mod:`gui` Package
+------------------
+
+.. automodule:: leap.gui
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`constants` Module
+-----------------------
+
+.. automodule:: leap.gui.constants
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`locale_rc` Module
+-----------------------
+
+.. automodule:: leap.gui.locale_rc
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`mainwindow_rc` Module
+---------------------------
+
+.. automodule:: leap.gui.mainwindow_rc
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`progress` Module
+----------------------
+
+.. automodule:: leap.gui.progress
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`styles` Module
+--------------------
+
+.. automodule:: leap.gui.styles
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`threads` Module
+---------------------
+
+.. automodule:: leap.gui.threads
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`utils` Module
+-------------------
+
+.. automodule:: leap.gui.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+    leap.gui.firstrun
+    leap.gui.tests
+
diff --git a/docs/api/leap.gui.tests.rst b/docs/api/leap.gui.tests.rst
new file mode 100644
index 00000000..60b0a6ca
--- /dev/null
+++ b/docs/api/leap.gui.tests.rst
@@ -0,0 +1,59 @@
+tests Package
+=============
+
+:mod:`test_firstrun_login` Module
+---------------------------------
+
+.. automodule:: leap.gui.tests.test_firstrun_login
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_firstrun_providerselect` Module
+------------------------------------------
+
+.. automodule:: leap.gui.tests.test_firstrun_providerselect
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_firstrun_register` Module
+------------------------------------
+
+.. automodule:: leap.gui.tests.test_firstrun_register
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_firstrun_wizard` Module
+----------------------------------
+
+.. automodule:: leap.gui.tests.test_firstrun_wizard
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_mainwindow_rc` Module
+--------------------------------
+
+.. automodule:: leap.gui.tests.test_mainwindow_rc
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_progress` Module
+---------------------------
+
+.. automodule:: leap.gui.tests.test_progress
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_threads` Module
+--------------------------
+
+.. automodule:: leap.gui.tests.test_threads
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/api/leap.rst b/docs/api/leap.rst
new file mode 100644
index 00000000..ce715c5d
--- /dev/null
+++ b/docs/api/leap.rst
@@ -0,0 +1,41 @@
+leap Package
+============
+
+:mod:`leap` Package
+-------------------
+
+.. automodule:: leap.__init__
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`_version` Module
+----------------------
+
+.. automodule:: leap._version
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`app` Module
+-----------------
+
+.. automodule:: leap.app
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+    leap.base
+    leap.baseapp
+    leap.certs
+    leap.crypto
+    leap.eip
+    leap.gui
+    leap.testing
+    leap.util
+
diff --git a/docs/api/leap.testing.rst b/docs/api/leap.testing.rst
new file mode 100644
index 00000000..dfad1b0c
--- /dev/null
+++ b/docs/api/leap.testing.rst
@@ -0,0 +1,43 @@
+testing Package
+===============
+
+:mod:`basetest` Module
+----------------------
+
+.. automodule:: leap.testing.basetest
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`https_server` Module
+--------------------------
+
+.. automodule:: leap.testing.https_server
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`pyqt` Module
+------------------
+
+.. automodule:: leap.testing.pyqt
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`qunittest` Module
+-----------------------
+
+.. automodule:: leap.testing.qunittest
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_basetest` Module
+---------------------------
+
+.. automodule:: leap.testing.test_basetest
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/api/leap.util.rst b/docs/api/leap.util.rst
new file mode 100644
index 00000000..dbb69ebe
--- /dev/null
+++ b/docs/api/leap.util.rst
@@ -0,0 +1,66 @@
+util Package
+============
+
+:mod:`coroutines` Module
+------------------------
+
+.. automodule:: leap.util.coroutines
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`dicts` Module
+-------------------
+
+.. automodule:: leap.util.dicts
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`fileutil` Module
+----------------------
+
+.. automodule:: leap.util.fileutil
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`leap_argparse` Module
+---------------------------
+
+.. automodule:: leap.util.leap_argparse
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`misc` Module
+------------------
+
+.. automodule:: leap.util.misc
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`translations` Module
+--------------------------
+
+.. automodule:: leap.util.translations
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`web` Module
+-----------------
+
+.. automodule:: leap.util.web
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+    leap.util.tests
+
diff --git a/docs/api/leap.util.tests.rst b/docs/api/leap.util.tests.rst
new file mode 100644
index 00000000..eb6654c4
--- /dev/null
+++ b/docs/api/leap.util.tests.rst
@@ -0,0 +1,19 @@
+tests Package
+=============
+
+:mod:`test_fileutil` Module
+---------------------------
+
+.. automodule:: leap.util.tests.test_fileutil
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_leap_argparse` Module
+--------------------------------
+
+.. automodule:: leap.util.tests.test_leap_argparse
+    :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
diff --git a/docs/index.rst b/docs/index.rst
index 017fa32c..a57e030f 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -78,10 +78,14 @@ API Documentation
 
 If you are looking for a reference to specific classes or functions, you are likely to find it here
 
+.. I should investigate a bit more how to skip some things, and how to give nice format
+   to the docstrings.
+   Maybe we should not have sphinx-apidocs building everything, but a minimal index of our own.
+
 .. note::
-   when it's finished, that's it :)
+   when it's a bit more polished, that's it :)
 
 .. toctree::
    :maxdepth: 2
 
-   api
+   api/leap