fixes to get RTD builds working again. (project-koku#86)

make RTD builds work again
lcouzens · May 2, 2018 · 8ed2b8a · 8ed2b8a
1 parent 75a4989
commit 8ed2b8a
Show file tree

Hide file tree

Showing 13 changed files with 205 additions and 27 deletions.
diff --git a/README.rst b/README.rst
@@ -1,5 +1,5 @@
 ===========
-Koku
+Koku README
 ===========
 
 |license| |Build Status| |codecov| |Updates| |Python 3| |Docs|

diff --git a/docs/Makefile b/docs/Makefile
@@ -14,6 +14,18 @@ help:
 
 .PHONY: help Makefile
 
+regen-apidocs:
+	sphinx-apidoc \
+		--ext-autodoc \
+		--ext-doctest \
+		--ext-intersphinx \
+		--ext-todo \
+		--ext-coverage \
+		--ext-mathjax \
+		--ext-viewcode \
+		-o source/koku \
+		../koku
+
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile

diff --git a/docs/rtd_requirements.txt b/docs/rtd_requirements.txt
@@ -1,15 +1,37 @@
-boto3==1.7.10
-botocore==1.10.10
-django-environ==0.4.4
-django==2.0.4
-djangorestframework==3.8.2
+-i https://pypi.python.org/simple
+alabaster==0.7.10
+astroid==1.6.3
+babel==2.5.3
+certifi==2018.4.16
+chardet==3.0.4
+codecov==2.0.15
+coverage==4.5.1
 docutils==0.14
-gunicorn==19.8.0
-jmespath==0.9.3
-psycopg2==2.7.4
-python-dateutil==2.7.2
+idna==2.6
+imagesize==1.0.0
+isort==4.3.4
+jinja2==2.10
+jsonschema==2.6.0
+lazy-object-proxy==1.3.1
+markupsafe==1.0
+mccabe==0.6.1
+packaging==17.1
+pluggy==0.6.0
+py==1.5.3
+pygments==2.2.0
+pylint==1.8.4
+pyparsing==2.2.0
 pytz==2018.4
-s3transfer==0.1.13
+pyyaml==3.12
+requests==2.18.4
 six==1.11.0
+snowballstemmer==1.2.1
+sphinx-rtd-theme==0.3.0
+sphinx==1.7.4
+sphinxcontrib-httpdomain==1.6.1
 sphinxcontrib-openapi==0.3.2
-whitenoise==3.3.1
+sphinxcontrib-websupport==1.0.1
+tox==3.0.0
+urllib3==1.22
+virtualenv==15.2.0
+wrapt==1.10.11
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -15,11 +15,9 @@
 import os
 import sys
 
+# Ensure django is set up
 import django
-
 sys.path.insert(0, os.path.abspath('../../koku/'))
-
-# Ensure django is set up
 os.environ['DJANGO_SETTINGS_MODULE'] = 'koku.settings'
 django.setup()
 
@@ -78,7 +76,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path .
-exclude_patterns = []
+exclude_patterns = ["**/*.migrations.rst",]
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
@@ -165,7 +163,7 @@
 #  dir menu entry, description, category)
 texinfo_documents = [
     (master_doc, 'Koku', 'Koku Documentation',
-     author, 'Koku', 'One line description of project.',
+     author, 'Koku', 'Cloud Cost Management',
      'Miscellaneous'),
 ]
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -12,9 +12,8 @@ Welcome to Koku's documentation!
 
    README
    CONTRIBUTING
-   api
-   modules
    openshift
+   api
 
 Indices and tables
 ==================

diff --git a/docs/source/koku/api.migrations.rst b/docs/source/koku/api.migrations.rst
@@ -0,0 +1,22 @@
+api.migrations package
+======================
+
+Submodules
+----------
+
+api.migrations.0001\_initial module
+-----------------------------------
+
+.. automodule:: api.migrations.0001_initial
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: api.migrations
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/koku/api.rst b/docs/source/koku/api.rst
@@ -0,0 +1,62 @@
+api package
+===========
+
+Subpackages
+-----------
+
+.. toctree::
+
+    api.migrations
+    api.status
+
+Submodules
+----------
+
+api.admin module
+----------------
+
+.. automodule:: api.admin
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+api.apps module
+---------------
+
+.. automodule:: api.apps
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+api.models module
+-----------------
+
+.. automodule:: api.models
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+api.urls module
+---------------
+
+.. automodule:: api.urls
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+api.views module
+----------------
+
+.. automodule:: api.views
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: api
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/koku/api.status.rst b/docs/source/koku/api.status.rst
@@ -0,0 +1,38 @@
+api.status package
+==================
+
+Submodules
+----------
+
+api.status.model module
+-----------------------
+
+.. automodule:: api.status.model
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+api.status.serializer module
+----------------------------
+
+.. automodule:: api.status.serializer
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+api.status.view module
+----------------------
+
+.. automodule:: api.status.view
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: api.status
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/koku/gunicorn.rst b/docs/source/koku/gunicorn.rst
@@ -0,0 +1,7 @@
+gunicorn module
+===============
+
+.. automodule:: gunicorn
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/koku.rst → docs/source/koku/koku.rst b/docs/source/koku.rst → docs/source/koku/koku.rst
@@ -1,35 +1,43 @@
 koku package
-==================
+============
 
 Submodules
 ----------
 
 koku.database module
---------------------------
+--------------------
 
 .. automodule:: koku.database
     :members:
     :undoc-members:
     :show-inheritance:
 
+koku.env module
+---------------
+
+.. automodule:: koku.env
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 koku.settings module
---------------------------
+--------------------
 
 .. automodule:: koku.settings
     :members:
     :undoc-members:
     :show-inheritance:
 
 koku.urls module
-----------------------
+----------------
 
 .. automodule:: koku.urls
     :members:
     :undoc-members:
     :show-inheritance:
 
 koku.wsgi module
-----------------------
+----------------
 
 .. automodule:: koku.wsgi
     :members:

diff --git a/docs/source/koku/manage.rst b/docs/source/koku/manage.rst
@@ -0,0 +1,7 @@
+manage module
+=============
+
+.. automodule:: manage
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/modules.rst → docs/source/koku/modules.rst b/docs/source/modules.rst → docs/source/koku/modules.rst
@@ -1,7 +1,10 @@
-Koku Modules
-==================
+koku
+====
 
 .. toctree::
    :maxdepth: 4
 
+   api
+   gunicorn
    koku
+   manage
diff --git a/koku/api/status/model.py b/koku/api/status/model.py
@@ -95,7 +95,7 @@ def startup(self):
         logger.info('Python: %s', self.python_version)
         module_list = []
         for name, value in self.modules.items():
-            module_list.append(module_list.append(f'{name} - {value}'))
+            module_list.append(module_list.append('{name} - {value}'))
         if module_list:
             logger.info('Modules: None')
         else: