From 9eefdbd9f3bc2c1ab0989e58ffbc37ecefcee9f4 Mon Sep 17 00:00:00 2001 From: Radovan Bast Date: Mon, 22 Jun 2015 15:10:55 +0200 Subject: [PATCH] document the doc --- doc/documentation.rst | 11 +++++++++++ doc/index.rst | 9 +++++---- 2 files changed, 16 insertions(+), 4 deletions(-) create mode 100644 doc/documentation.rst diff --git a/doc/documentation.rst b/doc/documentation.rst new file mode 100644 index 0000000..049348c --- /dev/null +++ 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 index f2e6c10..506b7c5 100644 --- 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