From 5ff29dc57e2877a14e705d09b7042cddf4165d0a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Touceda?= Date: Wed, 6 Mar 2013 15:27:23 -0300 Subject: Remove everything to start from scratch --- docs/api/leap.base.rst | 98 ------------------------------------------ docs/api/leap.base.tests.rst | 43 ------------------ docs/api/leap.baseapp.rst | 75 -------------------------------- docs/api/leap.certs.rst | 11 ----- docs/api/leap.crypto.rst | 26 ----------- docs/api/leap.crypto.tests.rst | 11 ----- docs/api/leap.eip.rst | 74 ------------------------------- docs/api/leap.eip.tests.rst | 43 ------------------ docs/api/leap.gui.firstrun.rst | 91 --------------------------------------- docs/api/leap.gui.rst | 75 -------------------------------- docs/api/leap.gui.tests.rst | 59 ------------------------- docs/api/leap.rst | 41 ------------------ docs/api/leap.testing.rst | 43 ------------------ docs/api/leap.util.rst | 66 ---------------------------- docs/api/leap.util.tests.rst | 19 -------- docs/api/modules.rst | 7 --- 16 files changed, 782 deletions(-) delete mode 100644 docs/api/leap.base.rst delete mode 100644 docs/api/leap.base.tests.rst delete mode 100644 docs/api/leap.baseapp.rst delete mode 100644 docs/api/leap.certs.rst delete mode 100644 docs/api/leap.crypto.rst delete mode 100644 docs/api/leap.crypto.tests.rst delete mode 100644 docs/api/leap.eip.rst delete mode 100644 docs/api/leap.eip.tests.rst delete mode 100644 docs/api/leap.gui.firstrun.rst delete mode 100644 docs/api/leap.gui.rst delete mode 100644 docs/api/leap.gui.tests.rst delete mode 100644 docs/api/leap.rst delete mode 100644 docs/api/leap.testing.rst delete mode 100644 docs/api/leap.util.rst delete mode 100644 docs/api/leap.util.tests.rst delete mode 100644 docs/api/modules.rst (limited to 'docs/api') diff --git a/docs/api/leap.base.rst b/docs/api/leap.base.rst deleted file mode 100644 index 778836c4..00000000 --- a/docs/api/leap.base.rst +++ /dev/null @@ -1,98 +0,0 @@ -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 deleted file mode 100644 index 7af035b0..00000000 --- a/docs/api/leap.base.tests.rst +++ /dev/null @@ -1,43 +0,0 @@ -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 deleted file mode 100644 index f24b4976..00000000 --- a/docs/api/leap.baseapp.rst +++ /dev/null @@ -1,75 +0,0 @@ -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 deleted file mode 100644 index e9cc2524..00000000 --- a/docs/api/leap.certs.rst +++ /dev/null @@ -1,11 +0,0 @@ -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 deleted file mode 100644 index a04e2e1d..00000000 --- a/docs/api/leap.crypto.rst +++ /dev/null @@ -1,26 +0,0 @@ -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 deleted file mode 100644 index 54ffa62f..00000000 --- a/docs/api/leap.crypto.tests.rst +++ /dev/null @@ -1,11 +0,0 @@ -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 deleted file mode 100644 index e418461b..00000000 --- a/docs/api/leap.eip.rst +++ /dev/null @@ -1,74 +0,0 @@ -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 deleted file mode 100644 index 932a074f..00000000 --- a/docs/api/leap.eip.tests.rst +++ /dev/null @@ -1,43 +0,0 @@ -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 deleted file mode 100644 index 36470c33..00000000 --- a/docs/api/leap.gui.firstrun.rst +++ /dev/null @@ -1,91 +0,0 @@ -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 deleted file mode 100644 index a35a7856..00000000 --- a/docs/api/leap.gui.rst +++ /dev/null @@ -1,75 +0,0 @@ -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 deleted file mode 100644 index 60b0a6ca..00000000 --- a/docs/api/leap.gui.tests.rst +++ /dev/null @@ -1,59 +0,0 @@ -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 deleted file mode 100644 index ce715c5d..00000000 --- a/docs/api/leap.rst +++ /dev/null @@ -1,41 +0,0 @@ -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 deleted file mode 100644 index dfad1b0c..00000000 --- a/docs/api/leap.testing.rst +++ /dev/null @@ -1,43 +0,0 @@ -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 deleted file mode 100644 index dbb69ebe..00000000 --- a/docs/api/leap.util.rst +++ /dev/null @@ -1,66 +0,0 @@ -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 deleted file mode 100644 index eb6654c4..00000000 --- a/docs/api/leap.util.tests.rst +++ /dev/null @@ -1,19 +0,0 @@ -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 deleted file mode 100644 index d49776ae..00000000 --- a/docs/api/modules.rst +++ /dev/null @@ -1,7 +0,0 @@ -leap -==== - -.. toctree:: - :maxdepth: 4 - - leap -- cgit v1.2.3 From 2dae2703fb8c2ae7e721ce83020c0dd10ff9ca33 Mon Sep 17 00:00:00 2001 From: kali Date: Fri, 3 May 2013 02:59:22 +0900 Subject: updated documentation * documentation reviewed after rewrite, ready for 0.2.1 * updated docstrings format to fit sphinx autodoc --- docs/api/leap.config.rst | 27 +++++++++++++++++++ docs/api/leap.crypto.rst | 34 ++++++++++++++++++++++++ docs/api/leap.crypto.tests.rst | 27 +++++++++++++++++++ docs/api/leap.gui.rst | 59 +++++++++++++++++++++++++++++++++++++++++ docs/api/leap.platform_init.rst | 27 +++++++++++++++++++ docs/api/leap.rst | 24 +++++++++++++++++ docs/api/leap.services.eip.rst | 59 +++++++++++++++++++++++++++++++++++++++++ docs/api/leap.services.rst | 10 +++++++ docs/api/leap.util.rst | 43 ++++++++++++++++++++++++++++++ docs/api/modules.rst | 7 +++++ 10 files changed, 317 insertions(+) create mode 100644 docs/api/leap.config.rst create mode 100644 docs/api/leap.crypto.rst create mode 100644 docs/api/leap.crypto.tests.rst create mode 100644 docs/api/leap.gui.rst create mode 100644 docs/api/leap.platform_init.rst create mode 100644 docs/api/leap.rst create mode 100644 docs/api/leap.services.eip.rst create mode 100644 docs/api/leap.services.rst create mode 100644 docs/api/leap.util.rst create mode 100644 docs/api/modules.rst (limited to 'docs/api') 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 -- cgit v1.2.3 From 065f5ab9b85fdb2fb1787b03bff925c7775427f6 Mon Sep 17 00:00:00 2001 From: kali Date: Wed, 12 Jun 2013 03:59:00 +0900 Subject: updated api --- docs/api/leap.gui.rst | 40 +++++++++++++++++++++++++++++ docs/api/leap.keymanager.rst | 50 ++++++++++++++++++++++++++++++++++++ docs/api/leap.keymanager.tests.rst | 11 ++++++++ docs/api/leap.rst | 18 ++++++++++++- docs/api/leap.services.eip.rst | 19 +++++++++----- docs/api/leap.services.eip.tests.rst | 11 ++++++++ docs/api/leap.services.mail.rst | 27 +++++++++++++++++++ docs/api/leap.services.rst | 18 +++++++++++++ docs/api/leap.services.soledad.rst | 27 +++++++++++++++++++ docs/api/leap.util.rst | 18 +++++++++---- 10 files changed, 227 insertions(+), 12 deletions(-) create mode 100644 docs/api/leap.keymanager.rst create mode 100644 docs/api/leap.keymanager.tests.rst create mode 100644 docs/api/leap.services.eip.tests.rst create mode 100644 docs/api/leap.services.mail.rst create mode 100644 docs/api/leap.services.soledad.rst (limited to 'docs/api') diff --git a/docs/api/leap.gui.rst b/docs/api/leap.gui.rst index 1559e079..d78de5d3 100644 --- a/docs/api/leap.gui.rst +++ b/docs/api/leap.gui.rst @@ -1,6 +1,14 @@ gui Package =========== +:mod:`gui` Package +------------------ + +.. automodule:: leap.gui + :members: + :undoc-members: + :show-inheritance: + :mod:`locale_rc` Module ----------------------- @@ -9,6 +17,22 @@ gui Package :undoc-members: :show-inheritance: +:mod:`loggerwindow` Module +-------------------------- + +.. automodule:: leap.gui.loggerwindow + :members: + :undoc-members: + :show-inheritance: + +:mod:`loggerwindow_rc` Module +----------------------------- + +.. automodule:: leap.gui.loggerwindow_rc + :members: + :undoc-members: + :show-inheritance: + :mod:`mainwindow` Module ------------------------ @@ -25,6 +49,22 @@ gui Package :undoc-members: :show-inheritance: +:mod:`twisted_main` Module +-------------------------- + +.. automodule:: leap.gui.twisted_main + :members: + :undoc-members: + :show-inheritance: + +:mod:`ui_loggerwindow` Module +----------------------------- + +.. automodule:: leap.gui.ui_loggerwindow + :members: + :undoc-members: + :show-inheritance: + :mod:`ui_mainwindow` Module --------------------------- diff --git a/docs/api/leap.keymanager.rst b/docs/api/leap.keymanager.rst new file mode 100644 index 00000000..0de8fc5f --- /dev/null +++ b/docs/api/leap.keymanager.rst @@ -0,0 +1,50 @@ +keymanager Package +================== + +:mod:`keymanager` Package +------------------------- + +.. automodule:: leap.keymanager + :members: + :undoc-members: + :show-inheritance: + +:mod:`errors` Module +-------------------- + +.. automodule:: leap.keymanager.errors + :members: + :undoc-members: + :show-inheritance: + +:mod:`gpg` Module +----------------- + +.. automodule:: leap.keymanager.gpg + :members: + :undoc-members: + :show-inheritance: + +:mod:`keys` Module +------------------ + +.. automodule:: leap.keymanager.keys + :members: + :undoc-members: + :show-inheritance: + +:mod:`openpgp` Module +--------------------- + +.. automodule:: leap.keymanager.openpgp + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + leap.keymanager.tests + diff --git a/docs/api/leap.keymanager.tests.rst b/docs/api/leap.keymanager.tests.rst new file mode 100644 index 00000000..9836bd01 --- /dev/null +++ b/docs/api/leap.keymanager.tests.rst @@ -0,0 +1,11 @@ +tests Package +============= + +:mod:`test_keymanager` Module +----------------------------- + +.. automodule:: leap.keymanager.tests.test_keymanager + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/api/leap.rst b/docs/api/leap.rst index 0f03c9e4..102f3b61 100644 --- a/docs/api/leap.rst +++ b/docs/api/leap.rst @@ -4,11 +4,26 @@ leap Package :mod:`leap` Package ------------------- -.. automodule:: leap +.. 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 ----------- @@ -18,6 +33,7 @@ Subpackages leap.config leap.crypto leap.gui + leap.keymanager leap.platform_init leap.services leap.util diff --git a/docs/api/leap.services.eip.rst b/docs/api/leap.services.eip.rst index 0cf489cf..450c1a93 100644 --- a/docs/api/leap.services.eip.rst +++ b/docs/api/leap.services.eip.rst @@ -41,19 +41,26 @@ eip Package :undoc-members: :show-inheritance: -:mod:`vpn` Module ------------------ +:mod:`vpnlaunchers` Module +-------------------------- -.. automodule:: leap.services.eip.vpn +.. automodule:: leap.services.eip.vpnlaunchers :members: :undoc-members: :show-inheritance: -:mod:`vpnlaunchers` Module --------------------------- +:mod:`vpnprocess` Module +------------------------ -.. automodule:: leap.services.eip.vpnlaunchers +.. automodule:: leap.services.eip.vpnprocess :members: :undoc-members: :show-inheritance: +Subpackages +----------- + +.. toctree:: + + leap.services.eip.tests + diff --git a/docs/api/leap.services.eip.tests.rst b/docs/api/leap.services.eip.tests.rst new file mode 100644 index 00000000..ea6e8ba5 --- /dev/null +++ b/docs/api/leap.services.eip.tests.rst @@ -0,0 +1,11 @@ +tests Package +============= + +:mod:`test_eipconfig` Module +---------------------------- + +.. automodule:: leap.services.eip.tests.test_eipconfig + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/api/leap.services.mail.rst b/docs/api/leap.services.mail.rst new file mode 100644 index 00000000..bd479972 --- /dev/null +++ b/docs/api/leap.services.mail.rst @@ -0,0 +1,27 @@ +mail Package +============ + +:mod:`smtpbootstrapper` Module +------------------------------ + +.. automodule:: leap.services.mail.smtpbootstrapper + :members: + :undoc-members: + :show-inheritance: + +:mod:`smtpconfig` Module +------------------------ + +.. automodule:: leap.services.mail.smtpconfig + :members: + :undoc-members: + :show-inheritance: + +:mod:`smtpspec` Module +---------------------- + +.. automodule:: leap.services.mail.smtpspec + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/api/leap.services.rst b/docs/api/leap.services.rst index 1a35ab5b..e5b22e64 100644 --- a/docs/api/leap.services.rst +++ b/docs/api/leap.services.rst @@ -1,10 +1,28 @@ services Package ================ +:mod:`abstractbootstrapper` Module +---------------------------------- + +.. automodule:: leap.services.abstractbootstrapper + :members: + :undoc-members: + :show-inheritance: + +:mod:`tx` Module +---------------- + +.. automodule:: leap.services.tx + :members: + :undoc-members: + :show-inheritance: + Subpackages ----------- .. toctree:: leap.services.eip + leap.services.mail + leap.services.soledad diff --git a/docs/api/leap.services.soledad.rst b/docs/api/leap.services.soledad.rst new file mode 100644 index 00000000..efefeb50 --- /dev/null +++ b/docs/api/leap.services.soledad.rst @@ -0,0 +1,27 @@ +soledad Package +=============== + +:mod:`soledadbootstrapper` Module +--------------------------------- + +.. automodule:: leap.services.soledad.soledadbootstrapper + :members: + :undoc-members: + :show-inheritance: + +:mod:`soledadconfig` Module +--------------------------- + +.. automodule:: leap.services.soledad.soledadconfig + :members: + :undoc-members: + :show-inheritance: + +:mod:`soledadspec` Module +------------------------- + +.. automodule:: leap.services.soledad.soledadspec + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/api/leap.util.rst b/docs/api/leap.util.rst index 85eb79da..601f6cba 100644 --- a/docs/api/leap.util.rst +++ b/docs/api/leap.util.rst @@ -9,18 +9,18 @@ util Package :undoc-members: :show-inheritance: -:mod:`checkerthread` Module +:mod:`leap_argparse` Module --------------------------- -.. automodule:: leap.util.checkerthread +.. automodule:: leap.util.leap_argparse :members: :undoc-members: :show-inheritance: -:mod:`leap_argparse` Module ---------------------------- +:mod:`leap_log_handler` Module +------------------------------ -.. automodule:: leap.util.leap_argparse +.. automodule:: leap.util.leap_log_handler :members: :undoc-members: :show-inheritance: @@ -41,3 +41,11 @@ util Package :undoc-members: :show-inheritance: +:mod:`requirement_checker` Module +--------------------------------- + +.. automodule:: leap.util.requirement_checker + :members: + :undoc-members: + :show-inheritance: + -- cgit v1.2.3