Links to docs.

praekelt · Jun 6, 2014 · c709fe1 · c709fe1
1 parent 909862a
commit c709fe1
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 2 deletions.
diff --git a/README.rst b/README.rst
@@ -12,8 +12,27 @@ Declarative configuration access and validation system.
 .. _confmodel-cover: https://coveralls.io/r/praekelt/confmodel
 
 
+Documentation
+-------------
+
+Up to date documentation can be found at:
+
+  * http://confmodel.readthedocs.org/en/latest/ for the latest release
+  * http://confmodel.readthedocs.org/en/develop/ for the latest development
+    version
+
+Documentation specific to a branch can be built from a clone of the
+repository::
+
+  $ pip install -r requirements-docs.txt
+  $ (cd docs; make html)
+
+The resulting HTML will be in ``docs/_build/html/``.
+
+
+
 Release process
-===============
+---------------
 
 Version numbers are generated by `versioneer`_. When releasing a new version,
 it's important to tag the appropriate commit before building packages. For

diff --git a/docs/index.rst b/docs/index.rst
@@ -13,7 +13,11 @@ confmodel: A declarative configuration access and validation system.
 .. note::
 
    This documentation is not yet complete. It will be updated and improved as
-   we work on confmodel.
+   we work on confmodel. Up to date documentation can be found at:
+
+     * http://confmodel.readthedocs.org/en/latest/ for the latest release
+     * http://confmodel.readthedocs.org/en/develop/ for the latest development
+       version
 
    Thank you for your attention.