Updating documentation (#849)

CHANGELOG.rst

@@ -19,15 +19,11 @@ Other Highlights:
 * Closed `#501 <https://github.com/Netflix/lemur/issues/501>`_ - Endpoint resource as now kept in sync via an
 expiration mechanism. Such that non-existant endpoints gracefully fall out of Lemur. Certificates are never
 removed from Lemur.
-
 * Closed `#551 <https://github.com/Netflix/lemur/pull/551>`_ - Added the ability to create a 4096 bit key during certificate
 creation. Closed `#528 <https://github.com/Netflix/lemur/pull/528>`_ to ensure that issuer plugins supported the new 4096 bit keys.
-
 * Closed `#566 <https://github.com/Netflix/lemur/issues/566>`_ - Fixed an issue changing the notification status for  certificates
 without private keys.
-
 * Closed `#594 <https://github.com/Netflix/lemur/issues/594>`_ - Added `replaced` field indicating if a certificate has been superseded.
-
 * Closed `#602 <https://github.com/Netflix/lemur/issues/602>`_ - AWS plugin added support for ALBs for endpoint tracking.
 
 

docs/developer/index.rst

@@ -283,6 +283,31 @@ Domains
     :undoc-members:
     :show-inheritance:
 
+Endpoints
+---------
+
+.. automodule:: lemur.endpoints.views
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Logs
+----
+
+.. automodule:: lemur.logs.views
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Sources
+-------
+
+.. automodule:: lemur.sources.views
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 
 Internals
 =========

docs/developer/internals/lemur.certificates.rst

@@ -1,15 +1,6 @@
 certificates Package
 ====================
 
-:mod:`exceptions` Module
-------------------------
-
-.. automodule:: lemur.certificates.exceptions
-    :noindex:
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 :mod:`models` Module
 --------------------
 

docs/developer/internals/lemur.plugins.lemur_verisign.rst

@@ -10,15 +10,6 @@ lemur_verisign Package
     :undoc-members:
     :show-inheritance:
 
-:mod:`constants` Module
------------------------
-
-.. automodule:: lemur.plugins.lemur_verisign.constants
-    :noindex:
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 :mod:`plugin` Module
 --------------------
 

docs/developer/internals/lemur.rst

@@ -97,3 +97,19 @@ Subpackages
     lemur.plugins
     lemur.roles
     lemur.users
+    lemur.sources
+    lemur.logs
+    lemur.reporting
+    lemur.tests
+    lemur.deployment
+    lemur.endpoints
+    lemur.defaults
+    lemur.plugins.lemur_acme
+    lemur.plugins.lemur_atlas
+    lemur.plugins.lemur_cryptography
+    lemur.plugins.lemur_digicert
+    lemur.plugins.lemur_java
+    lemur.plugins.lemur_kubernetes
+    lemur.plugins.lemur_linuxdst
+    lemur.plugins.lemur_openssl
+    lemur.plugins.lemur_slack

docs/faq.rst

@@ -6,7 +6,7 @@ Common Problems
 
 In my startup logs I see *'Aborting... Lemur cannot locate db encryption key, is LEMUR_ENCRYPTION_KEYS set?'*
   You likely have not correctly configured **LEMUR_ENCRYPTION_KEYS**. See
-  :doc:`administration/index` for more information.
+  :doc:`administration` for more information.
 
 
 I am seeing Lemur's javascript load in my browser but not the CSS.

docs/requirements.txt

@@ -1,54 +1,33 @@
-alabaster==0.7.8
+Flask==0.12
-alembic==0.8.6
+Flask-RESTful==0.3.6
-aniso8601==1.1.0
-arrow==0.7.0
-Babel==2.3.4
-bcrypt==2.0.0
-beautifulsoup4==4.4.1
-blinker==1.4
-boto==2.38.0
-cffi==1.7.0
-cryptography==1.3.2
-docutils==0.12
-enum34==1.1.6
-Flask==0.10.1
-Flask-Bcrypt==0.7.1
-Flask-Mail==0.9.1
-Flask-Migrate==1.7.0
-Flask-Principal==0.4.0
-Flask-RESTful==0.3.3
-Flask-Script==2.0.5
 Flask-SQLAlchemy==2.1
-future==0.15.2
+Flask-Script==2.0.5
-gunicorn==19.4.1
+Flask-Migrate==2.0.4
-idna==2.1
+Flask-Bcrypt==0.7.1
-imagesize==0.7.1
+Flask-Principal==0.4.0
-inflection==0.3.1
+Flask-Mail==0.9.1
-ipaddress==1.0.16
+SQLAlchemy-Utils==0.32.14
-itsdangerous==0.24
+requests==2.11.1
-Jinja2==2.8
+ndg-httpsclient==0.4.2
-lockfile==0.12.2
+psycopg2==2.7.1
-Mako==1.0.4
+arrow==0.10.0
-MarkupSafe==0.23
-marshmallow==2.4.0
-marshmallow-sqlalchemy==0.8.0
-psycopg2==2.6.1
-pyasn1==0.1.9
-pycparser==2.14
-pycrypto==2.6.1
-Pygments==2.1.3
-PyJWT==1.4.0
-pyOpenSSL==0.15.1
-python-dateutil==2.5.3
-python-editor==1.0.1
-pytz==2016.4
-requests==2.9.1
 six==1.10.0
-snowballstemmer==1.2.1
+marshmallow-sqlalchemy==0.13.1
-Sphinx==1.4.4
+gunicorn==19.7.1
-sphinx-rtd-theme==0.1.9
+marshmallow==2.13.5
-sphinxcontrib-httpdomain==1.5.0
+cryptography==1.9
-SQLAlchemy==1.0.13
+xmltodict==0.11.0
-SQLAlchemy-Utils==0.31.4
+pyjwt==1.5.0
-Werkzeug==0.11.10
+lockfile==0.12.2
-xmltodict==0.9.2
+inflection==0.3.1
+future==0.16.0
+boto3==1.4.4
+acme==0.15.0
+retrying==1.3.3
+tabulate==0.7.7
+pem==16.1.0
+raven[flask]==6.1.0
+paramiko==2.2.1
+sphinx
+sphinxcontrib-httpdomain
+sphinx-rtd-theme

setup.py

@@ -29,7 +29,7 @@ ROOT = os.path.realpath(os.path.join(os.path.dirname(__file__)))
 sys.path.insert(0, ROOT)
 
 about = {}
-with open(os.path.join(ROOT, "lemur", "__about__.py")) as f:
+with open(os.path.join(ROOT, 'lemur', '__about__.py')) as f:
     exec(f.read(), about)  # nosec: about file is benign
 
 
@@ -63,6 +63,7 @@ install_requires = [
     'tabulate==0.7.7',
     'pem==16.1.0',
     'raven[flask]==6.1.0',
+    'jinja2==2.9.6',
     'paramiko==2.2.1'  # required for lemur_linuxdst plugin
 ]