diff options
| author | kali <kali@leap.se> | 2013-06-12 03:59:00 +0900 | 
|---|---|---|
| committer | kali <kali@leap.se> | 2013-06-12 03:59:21 +0900 | 
| commit | 065f5ab9b85fdb2fb1787b03bff925c7775427f6 (patch) | |
| tree | f0c2d547eb5a492c6749c7ba730709d096478ab2 | |
| parent | dbb873016042b213dd9cd84a59aec0c0a2383691 (diff) | |
updated api
| -rw-r--r-- | docs/api/leap.gui.rst | 40 | ||||
| -rw-r--r-- | docs/api/leap.keymanager.rst | 50 | ||||
| -rw-r--r-- | docs/api/leap.keymanager.tests.rst | 11 | ||||
| -rw-r--r-- | docs/api/leap.rst | 18 | ||||
| -rw-r--r-- | docs/api/leap.services.eip.rst | 19 | ||||
| -rw-r--r-- | docs/api/leap.services.eip.tests.rst | 11 | ||||
| -rw-r--r-- | docs/api/leap.services.mail.rst | 27 | ||||
| -rw-r--r-- | docs/api/leap.services.rst | 18 | ||||
| -rw-r--r-- | docs/api/leap.services.soledad.rst | 27 | ||||
| -rw-r--r-- | docs/api/leap.util.rst | 18 | ||||
| -rw-r--r-- | docs/conf.py | 22 | 
11 files changed, 247 insertions, 14 deletions
| 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: + diff --git a/docs/conf.py b/docs/conf.py index 4a90d7d5..39f17d9b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -16,7 +16,21 @@ import sys, os  # If extensions (or modules to document with autodoc) are in another directory,  # add these directories to sys.path here. If the directory is relative to the  # documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) +sys.path.insert(0, os.path.abspath('../src')) +sys.path.insert(0, os.path.abspath('../src/leap')) +sys.path.insert(0, os.path.abspath('../src/leap/crypto')) +sys.path.insert(0, os.path.abspath('../src/leap/keymanager')) +sys.path.insert(0, os.path.abspath('../src/leap/services')) +sys.path.insert(0, os.path.abspath('../src/leap/services/eip')) +sys.path.insert(0, os.path.abspath('../src/leap/util')) + +sys.path.insert(0, os.path.abspath( +    os.path.expanduser( +        '~/Virtualenvs/leap-client/local/lib/python2.7/' +        'site-packages/leap/common'))) + +# TODO: should add all the virtualenv site-packages to the path +# as a workaround, install all in your path.  # -- General configuration ----------------------------------------------------- @@ -25,7 +39,11 @@ import sys, os  # Add any Sphinx extension module names here, as strings. They can be extensions  # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc'] +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx'] + +intersphinx_mapping = {'python': ('http://docs.python.org/2.7', None), +                       'twisted': ('http://twistedsphinx.funsize.net/', +                                   None)}  # Add any paths that contain templates here, relative to this directory.  templates_path = ['_templates'] | 
