From 030b6708486ce328adc79563f248d8254be7a557 Mon Sep 17 00:00:00 2001 From: Radovan Bast Date: Mon, 27 Jul 2015 17:30:40 +0200 Subject: [PATCH] add todo item --- doc/contributors/{documentation.rst => doc.rst} | 8 ++++++-- doc/index.rst | 2 +- 2 files changed, 7 insertions(+), 3 deletions(-) rename doc/contributors/{documentation.rst => doc.rst} (68%) diff --git a/doc/contributors/documentation.rst b/doc/contributors/doc.rst similarity index 68% rename from doc/contributors/documentation.rst rename to doc/contributors/doc.rst index 049348c..bf243b0 100644 --- a/doc/contributors/documentation.rst +++ b/doc/contributors/doc.rst @@ -1,7 +1,7 @@ -Documentation -============= +Contributing to the documentation +================================= This documentation is refreshed upon each push to the central repository. @@ -9,3 +9,7 @@ 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). + +.. todo:: + + Mention the possibility to infer autocmake.cfg code from the documentation. diff --git a/doc/index.rst b/doc/index.rst index 778c869..4b6affb 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -37,7 +37,7 @@ For developers/contributors to Autocmake contributors/guidelines.rst contributors/testing.rst - contributors/documentation.rst + contributors/doc.rst Reference