document the doc

dev-cafe · Jun 22, 2015 · 9eefdbd · 9eefdbd
1 parent 77a8130
commit 9eefdbd
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 4 deletions.
diff --git a/doc/documentation.rst b/doc/documentation.rst
@@ -0,0 +1,11 @@
+
+
+Documentation
+=============
+
+This documentation is refreshed upon each push to the central repository.
+
+The module reference documentation is generated from the module sources using
+``#.rst:`` tags (compare for instance
+http://autocmake.readthedocs.org/en/latest/module-reference.html#cc-cmake with
+https://github.com/scisoft/autocmake/blob/master/modules/cc.cmake).
diff --git a/doc/index.rst b/doc/index.rst
@@ -13,7 +13,7 @@ General
    about.rst
 
 
-For Developers who use Autocmake
+For developers who use Autocmake
 --------------------------------
 
 .. toctree::
@@ -24,17 +24,18 @@ For Developers who use Autocmake
    updating-modules.rst
 
 
-For Users of projects that use Autocmake
-----------------------------------------
+For users of projects which use Autocmake
+-----------------------------------------
 
 
-For Developers/contributors to Autocmake
+For developers/contributors to Autocmake
 ----------------------------------------
 
 .. toctree::
    :maxdepth: 2
 
    testing.rst
+   documentation.rst
 
 
 Reference