From: Christian Herdtweck Date: Thu, 10 Sep 2015 15:52:46 +0000 (+0200) Subject: added reference to template.py to docu X-Git-Tag: v1.2~106 X-Git-Url: http://developer.intra2net.com/git/?a=commitdiff_plain;h=47df0969b509fda72e4cf03686ce52ce420a08b3;p=pyi2ncommon added reference to template.py to docu --- diff --git a/doc/about_docu.rst b/doc/about_docu.rst index 2c48517..2b172e9 100644 --- a/doc/about_docu.rst +++ b/doc/about_docu.rst @@ -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