From 18c81ab8fbcdd1beb2c52fac31137c3b352c1ba9 Mon Sep 17 00:00:00 2001 From: Radovan Bast Date: Mon, 5 Oct 2015 12:54:21 +0200 Subject: [PATCH] update doc for contributors --- doc/contributors/doc.rst | 9 ++++++--- doc/contributors/guidelines.rst | 2 +- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/doc/contributors/doc.rst b/doc/contributors/doc.rst index d846dd2..4e789fd 100644 --- a/doc/contributors/doc.rst +++ b/doc/contributors/doc.rst @@ -12,6 +12,9 @@ The module reference documentation is generated from the module sources using 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. +Please note that the lines following ``# autocmake.cfg configuration::`` are +understood by the ``update.py`` script to infer autocmake.cfg code from the +documentation. As an example consider +https://github.com/scisoft/autocmake/blob/master/modules/cc.cmake#L20-L25. +Here, ``update.py`` will infer the configurations for ``docopt``, ``export``, +and ``define``. diff --git a/doc/contributors/guidelines.rst b/doc/contributors/guidelines.rst index 862e9d7..3b717ad 100644 --- a/doc/contributors/guidelines.rst +++ b/doc/contributors/guidelines.rst @@ -7,4 +7,4 @@ Please follow the excellent guide: http://www.contribution-guide.org. We do not require any formal copyright assignment or contributor license agreement. Any contributions intentionally sent upstream are presumed to be -offered under terms of the OSI-approved BSD 3-clause License. +offered under terms of the OSI-approved BSD 3-clause license.