added reference to template.py to docu
authorChristian Herdtweck <christian.herdtweck@intra2net.com>
Thu, 10 Sep 2015 15:52:46 +0000 (17:52 +0200)
committerChristian Herdtweck <christian.herdtweck@intra2net.com>
Fri, 11 Sep 2015 07:16:23 +0000 (09:16 +0200)
doc/about_docu.rst

index 2c48517..2b172e9 100644 (file)
@@ -8,6 +8,7 @@ How to generate this documentation
 * Install Sphinx
 * change dir into doc
 * run sphinx-apidoc -o ./ ../
+  (you may have to add a -f if you added a new module)
 * run make html
   (this will create one .rst file for each python file in pyi2ncommon directory)
 
@@ -15,6 +16,7 @@ How to generate this documentation
 Good to know
 ------------
 
+* lots of example documentation can be found in the docu of template.py (:py:mod:`template`)
 * this Documentation was initialized using sphinx-quickstart
 * doc/conf.py can be used to configure lots of the documentation
 * the autodoc extension is responsible for creating .rst files from documentation in .py files