From c9fd0259903a887017ff1e64ad61f0c83b45ada8 Mon Sep 17 00:00:00 2001 From: Jonathan Stoppani Date: Mon, 5 Oct 2015 15:34:12 +0200 Subject: [PATCH] Add autodoc modules --- docs/_templates/page.html | 10 +++++++ docs/api/coolfig.django.rst | 7 +++++ docs/api/coolfig.providers.rst | 7 +++++ docs/api/coolfig.rst | 46 ++++++++++++++++++++++++++++++++ docs/api/coolfig.schema.rst | 7 +++++ docs/api/coolfig.test_config.rst | 7 +++++ docs/api/coolfig.test_django.rst | 7 +++++ docs/api/coolfig.types.rst | 7 +++++ docs/api/modules.rst | 7 +++++ docs/django.rst | 2 ++ docs/extending.rst | 8 ++++++ docs/index.rst | 25 ++++++++++------- docs/installation.rst | 2 ++ docs/quick-start.rst | 2 ++ 14 files changed, 135 insertions(+), 9 deletions(-) create mode 100644 docs/_templates/page.html create mode 100644 docs/api/coolfig.django.rst create mode 100644 docs/api/coolfig.providers.rst create mode 100644 docs/api/coolfig.rst create mode 100644 docs/api/coolfig.schema.rst create mode 100644 docs/api/coolfig.test_config.rst create mode 100644 docs/api/coolfig.test_django.rst create mode 100644 docs/api/coolfig.types.rst create mode 100644 docs/api/modules.rst create mode 100644 docs/django.rst create mode 100644 docs/extending.rst create mode 100644 docs/installation.rst create mode 100644 docs/quick-start.rst diff --git a/docs/_templates/page.html b/docs/_templates/page.html new file mode 100644 index 0000000..12ec486 --- /dev/null +++ b/docs/_templates/page.html @@ -0,0 +1,10 @@ +{% extends "!page.html" %} +{% block extrahead %} +{{ super() }} + +{% endblock %} diff --git a/docs/api/coolfig.django.rst b/docs/api/coolfig.django.rst new file mode 100644 index 0000000..8f131eb --- /dev/null +++ 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 new file mode 100644 index 0000000..faa39c1 --- /dev/null +++ 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 new file mode 100644 index 0000000..050f04b --- /dev/null +++ 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 new file mode 100644 index 0000000..a5e5b62 --- /dev/null +++ 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 new file mode 100644 index 0000000..fc31860 --- /dev/null +++ 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 new file mode 100644 index 0000000..b089b8a --- /dev/null +++ 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 new file mode 100644 index 0000000..19a519d --- /dev/null +++ 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 new file mode 100644 index 0000000..c821706 --- /dev/null +++ b/docs/api/modules.rst @@ -0,0 +1,7 @@ +coolfig +======= + +.. toctree:: + :maxdepth: 4 + + coolfig diff --git a/docs/django.rst b/docs/django.rst new file mode 100644 index 0000000..5debc04 --- /dev/null +++ b/docs/django.rst @@ -0,0 +1,2 @@ +Django integration +================== diff --git a/docs/extending.rst b/docs/extending.rst new file mode 100644 index 0000000..eaf3e94 --- /dev/null +++ b/docs/extending.rst @@ -0,0 +1,8 @@ +Extending coolfig +================= + +Custom providers +---------------- + +Custom types +------------ diff --git a/docs/index.rst b/docs/index.rst index 91ee007..fb741b0 100644 --- 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 `_. + +Coolfig is MIT-licensed. Source code is available on +`GitHub `_ and packages are distributed +through `PyPI `_. + 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 new file mode 100644 index 0000000..11e4437 --- /dev/null +++ b/docs/installation.rst @@ -0,0 +1,2 @@ +Installation +============ diff --git a/docs/quick-start.rst b/docs/quick-start.rst new file mode 100644 index 0000000..f9e002d --- /dev/null +++ b/docs/quick-start.rst @@ -0,0 +1,2 @@ +Quick start +===========