AnotherFoxGuy/autocmake
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update doc for contributors

Browse Source
This commit is contained in:
Radovan Bast
2015-10-05 12:54:21 +02:00
parent a8bc2b0a1f
commit 18c81ab8fb
2 changed files with 7 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
doc/contributors/doc.rst
View File

@ -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``.