updating docs with new API endpoints and plugin information

2015-07-30 22:54:59 -07:00
parent 11a6294162
commit d3b0822e14
28 changed files with 586 additions and 301 deletions
--- a/docs/developer/internals/lemur.accounts.rst
+++ b/docs/developer/internals/lemur.accounts.rst
@ -1,20 +0,0 @@
-accounts Package
-================
-
-:mod:`models` Module
--------------------
-
-.. automodule:: lemur.accounts.models
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`service` Module
---------------------
-
-.. automodule:: lemur.accounts.service
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
--- a/docs/developer/internals/lemur.analyze.rst
+++ b/docs/developer/internals/lemur.analyze.rst
@ -1,11 +0,0 @@
-analyze Package
-===============
-
-:mod:`service` Module
---------------------
-
-.. automodule:: lemur.analyze.service
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
--- a/docs/developer/internals/lemur.auth.rst
+++ b/docs/developer/internals/lemur.auth.rst
@ -17,4 +17,11 @@ auth Package
    :undoc-members:
    :show-inheritance:

+:mod:`views` Module
+-------------------
+
+.. automodule:: lemur.auth.views
+    :members:
+    :undoc-members:
+    :show-inheritance:

--- a/docs/developer/internals/lemur.authorities.rst
+++ b/docs/developer/internals/lemur.authorities.rst
@ -17,4 +17,11 @@ authorities Package
    :undoc-members:
    :show-inheritance:

+:mod:`views` Module
+-------------------
+
+.. automodule:: lemur.authorities.views
+    :members:
+    :undoc-members:
+    :show-inheritance:

--- a/docs/developer/internals/lemur.certificates.rst
+++ b/docs/developer/internals/lemur.certificates.rst
@ -5,6 +5,7 @@ certificates Package
 ------------------------

 .. automodule:: lemur.certificates.exceptions
+    :noindex:
    :members:
    :undoc-members:
    :show-inheritance:
@ -13,6 +14,7 @@ certificates Package
 --------------------

 .. automodule:: lemur.certificates.models
+    :noindex:
    :members:
    :undoc-members:
    :show-inheritance:
@ -21,6 +23,7 @@ certificates Package
 ---------------------

 .. automodule:: lemur.certificates.service
+    :noindex:
    :members:
    :undoc-members:
    :show-inheritance:
@ -29,6 +32,7 @@ certificates Package
 ------------------

 .. automodule:: lemur.certificates.sync
+    :noindex:
    :members:
    :undoc-members:
    :show-inheritance:
@ -37,7 +41,16 @@ certificates Package
 --------------------

 .. automodule:: lemur.certificates.verify
+    :noindex:
    :members:
    :undoc-members:
    :show-inheritance:

+:mod:`views` Module
+-------------------
+
+.. automodule:: lemur.certificates.views
+    :noindex:
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/docs/developer/internals/lemur.common.rst
+++ b/docs/developer/internals/lemur.common.rst
@ -1,14 +1,6 @@
 common Package
 ==============

-:mod:`crypto` Module
--------------------
-
-.. automodule:: lemur.common.crypto
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 :mod:`health` Module
 --------------------

@ -17,6 +9,14 @@ common Package
    :undoc-members:
    :show-inheritance:

+:mod:`managers` Module
+----------------------
+
+.. automodule:: lemur.common.managers
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 :mod:`utils` Module
 -------------------

@ -25,10 +25,3 @@ common Package
    :undoc-members:
    :show-inheritance:

-Subpackages
-----------
-
-.. toctree::
-
-    lemur.common.services
-
--- a/docs/developer/internals/lemur.common.services.aws.rst
+++ b/docs/developer/internals/lemur.common.services.aws.rst
@ -1,35 +0,0 @@
-aws Package
-===========
-
-:mod:`elb` Module
-----------------
-
-.. automodule:: lemur.common.services.aws.elb
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`iam` Module
-----------------
-
-.. automodule:: lemur.common.services.aws.iam
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`ses` Module
-----------------
-
-.. automodule:: lemur.common.services.aws.ses
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`sts` Module
-----------------
-
-.. automodule:: lemur.common.services.aws.sts
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
--- a/docs/developer/internals/lemur.common.services.issuers.plugins.cloudca.rst
+++ b/docs/developer/internals/lemur.common.services.issuers.plugins.cloudca.rst
@ -1,19 +0,0 @@
-cloudca Package
-===============
-
-:mod:`cloudca` Module
---------------------
-
-.. automodule:: lemur.common.services.issuers.plugins.cloudca.cloudca
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`constants` Module
-----------------------
-
-.. automodule:: lemur.common.services.issuers.plugins.cloudca.constants
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
--- a/docs/developer/internals/lemur.common.services.issuers.plugins.rst
+++ b/docs/developer/internals/lemur.common.services.issuers.plugins.rst
@ -1,11 +0,0 @@
-plugins Package
-===============
-
-Subpackages
-----------
-
-.. toctree::
-
-    lemur.common.services.issuers.plugins.cloudca
-    lemur.common.services.issuers.plugins.verisign
-
--- a/docs/developer/internals/lemur.common.services.issuers.plugins.verisign.rst
+++ b/docs/developer/internals/lemur.common.services.issuers.plugins.verisign.rst
@ -1,19 +0,0 @@
-verisign Package
-================
-
-:mod:`constants` Module
-----------------------
-
-.. automodule:: lemur.common.services.issuers.plugins.verisign.constants
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`verisign` Module
----------------------
-
-.. automodule:: lemur.common.services.issuers.plugins.verisign.verisign
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
--- a/docs/developer/internals/lemur.common.services.issuers.rst
+++ b/docs/developer/internals/lemur.common.services.issuers.rst
@ -1,26 +0,0 @@
-issuers Package
-===============
-
-:mod:`issuer` Module
--------------------
-
-.. automodule:: lemur.common.services.issuers.issuer
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`manager` Module
---------------------
-
-.. automodule:: lemur.common.services.issuers.manager
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-Subpackages
-----------
-
-.. toctree::
-
-    lemur.common.services.issuers.plugins
-
--- a/docs/developer/internals/lemur.common.services.rst
+++ b/docs/developer/internals/lemur.common.services.rst
@ -1,11 +0,0 @@
-services Package
-================
-
-Subpackages
-----------
-
-.. toctree::
-
-    lemur.common.services.aws
-    lemur.common.services.issuers
-
--- a/docs/developer/internals/lemur.domains.rst
+++ b/docs/developer/internals/lemur.domains.rst
@ -17,3 +17,11 @@ domains Package
    :undoc-members:
    :show-inheritance:

+:mod:`views` Module
+-------------------
+
+.. automodule:: lemur.domains.views
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
--- a/docs/developer/internals/lemur.elbs.rst
+++ b/docs/developer/internals/lemur.elbs.rst
@ -1,35 +0,0 @@
-elbs Package
-============
-
-:mod:`models` Module
--------------------
-
-.. automodule:: lemur.elbs.models
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`service` Module
---------------------
-
-.. automodule:: lemur.elbs.service
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`sync` Module
------------------
-
-.. automodule:: lemur.elbs.sync
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`views` Module
-------------------
-
-.. automodule:: lemur.elbs.views
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
--- a/docs/developer/internals/lemur.listeners.rst
+++ b/docs/developer/internals/lemur.listeners.rst
@ -1,27 +0,0 @@
-listeners Package
-=================
-
-:mod:`models` Module
--------------------
-
-.. automodule:: lemur.listeners.models
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`service` Module
---------------------
-
-.. automodule:: lemur.listeners.service
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`views` Module
-------------------
-
-.. automodule:: lemur.listeners.views
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
--- a/docs/developer/internals/lemur.roles.rst
+++ b/docs/developer/internals/lemur.roles.rst
@ -17,4 +17,10 @@ roles Package
    :undoc-members:
    :show-inheritance:

+:mod:`views` Module
+-------------------

+.. automodule:: lemur.roles.views
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/docs/developer/internals/lemur.rst
+++ b/docs/developer/internals/lemur.rst
@ -1,7 +1,20 @@
+lemur Package
+=============
+
+:mod:`lemur` Package
+--------------------
+
+.. automodule:: lemur.__init__
+    :noindex:
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 :mod:`constants` Module
 -----------------------

 .. automodule:: lemur.constants
+    :noindex:
    :members:
    :undoc-members:
    :show-inheritance:
@ -10,6 +23,7 @@
 ----------------------

 .. automodule:: lemur.database
+    :noindex:
    :members:
    :undoc-members:
    :show-inheritance:
@ -18,6 +32,7 @@
 ------------------------

 .. automodule:: lemur.decorators
+    :noindex:
    :members:
    :undoc-members:
    :show-inheritance:
@ -26,6 +41,7 @@
 ------------------------

 .. automodule:: lemur.exceptions
+    :noindex:
    :members:
    :undoc-members:
    :show-inheritance:
@ -34,6 +50,7 @@
 ------------------------

 .. automodule:: lemur.extensions
+    :noindex:
    :members:
    :undoc-members:
    :show-inheritance:
@ -42,6 +59,7 @@
 ---------------------

 .. automodule:: lemur.factory
+    :noindex:
    :members:
    :undoc-members:
    :show-inheritance:
@ -50,6 +68,7 @@
 --------------------

 .. automodule:: lemur.manage
+    :noindex:
    :members:
    :undoc-members:
    :show-inheritance:
@ -58,14 +77,7 @@
 --------------------

 .. automodule:: lemur.models
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`notifications` Module
---------------------------
-
-.. automodule:: lemur.notifications
+    :noindex:
    :members:
    :undoc-members:
    :show-inheritance:
@ -75,13 +87,14 @@ Subpackages

 .. toctree::

-    lemur.accounts
    lemur.auth
    lemur.authorities
    lemur.certificates
    lemur.common
+    lemur.destinations
    lemur.domains
+    lemur.notifications
+    lemur.plugins
    lemur.roles
    lemur.status
    lemur.users
-
--- a/docs/developer/internals/lemur.users.rst
+++ b/docs/developer/internals/lemur.users.rst
@ -17,3 +17,11 @@ users Package
    :undoc-members:
    :show-inheritance:

+:mod:`views` Module
+-------------------
+
+.. automodule:: lemur.users.views
+    :members:
+    :undoc-members:
+    :show-inheritance:
+