Add autodoc modules

GaretJax · Oct 5, 2015 · c9fd025 · c9fd025
1 parent 158e263
commit c9fd025
Show file tree

Hide file tree

Showing 14 changed files with 135 additions and 9 deletions.
diff --git a/docs/_templates/page.html b/docs/_templates/page.html
@@ -0,0 +1,10 @@
+{% extends "!page.html" %}
+{% block extrahead %}
+{{ super() }}
+<style type="text/css">
+    span.changelog-improvement {color: #4070A0;}
+    span.changelog-bug {color: #A04040;}
+    span.changelog-feature {color: #40A056;}
+    a.changelog-release {font-weight: bold;}
+</style>
+{% endblock %}
diff --git a/docs/api/coolfig.django.rst b/docs/api/coolfig.django.rst
@@ -0,0 +1,7 @@
+coolfig.django module
+=====================
+
+.. automodule:: coolfig.django
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/api/coolfig.providers.rst b/docs/api/coolfig.providers.rst
@@ -0,0 +1,7 @@
+coolfig.providers module
+========================
+
+.. automodule:: coolfig.providers
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/api/coolfig.rst b/docs/api/coolfig.rst
@@ -0,0 +1,46 @@
+API documentation
+=================
+
+Module contents
+---------------
+
+.. automodule:: coolfig
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Submodules
+----------
+
+coolfig.django module
++++++++++++++++++++++
+
+.. automodule:: coolfig.django
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+coolfig.providers module
+++++++++++++++++++++++++
+
+.. automodule:: coolfig.providers
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+coolfig.schema module
++++++++++++++++++++++
+
+.. automodule:: coolfig.schema
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+coolfig.types module
+++++++++++++++++++++
+
+.. automodule:: coolfig.types
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/api/coolfig.schema.rst b/docs/api/coolfig.schema.rst
@@ -0,0 +1,7 @@
+coolfig.schema module
+=====================
+
+.. automodule:: coolfig.schema
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/api/coolfig.test_config.rst b/docs/api/coolfig.test_config.rst
@@ -0,0 +1,7 @@
+coolfig.test_config module
+==========================
+
+.. automodule:: coolfig.test_config
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/api/coolfig.test_django.rst b/docs/api/coolfig.test_django.rst
@@ -0,0 +1,7 @@
+coolfig.test_django module
+==========================
+
+.. automodule:: coolfig.test_django
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/api/coolfig.types.rst b/docs/api/coolfig.types.rst
@@ -0,0 +1,7 @@
+coolfig.types module
+====================
+
+.. automodule:: coolfig.types
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/api/modules.rst b/docs/api/modules.rst
@@ -0,0 +1,7 @@
+coolfig
+=======
+
+.. toctree::
+   :maxdepth: 4
+
+   coolfig
diff --git a/docs/django.rst b/docs/django.rst
@@ -0,0 +1,2 @@
+Django integration
+==================
diff --git a/docs/extending.rst b/docs/extending.rst
@@ -0,0 +1,8 @@
+Extending coolfig
+=================
+
+Custom providers
+----------------
+
+Custom types
+------------
diff --git a/docs/index.rst b/docs/index.rst
@@ -3,20 +3,27 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
+===================================
 Welcome to coolfig's documentation!
 ===================================
 
+Coolfig is a library to easily write extensible configuration specifications to
+be fulfilled by various sources, such as config files or environment variables.
+It was written with the goal to make it easy to apply the
+`twelve-factor methodology <http://12factor.net/>`_.
+
+Coolfig is MIT-licensed. Source code is available on
+`GitHub <https://github.com/GaretJax/coolfig>`_ and packages are distributed
+through `PyPI <https://pypi.python.org/pypi/coolfig>`_.
+
 Contents:
 
 .. toctree::
    :maxdepth: 2
 
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-
+   installation
+   quick-start
+   extending
+   django
+   api/coolfig
+   changelog
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -0,0 +1,2 @@
+Installation
+============
diff --git a/docs/quick-start.rst b/docs/quick-start.rst
@@ -0,0 +1,2 @@
+Quick start
+===========