developer.intra2net.com Git - pyi2ncommon/blob - doc/about_docu.rst

   1 About this documentation
   2 ========================
   3
   4
   5 How to generate this documentation
   6 ----------------------------------
   7
   8 * Install Sphinx
   9 * change dir into doc
  10 * run sphinx-apidoc -o ./ ../src
  11   (you may have to add a -f if you added a new module)
  12 * run make html
  13   (this will create one .rst file for each python file in pyi2ncommon directory)
  14
  15
  16 Good to know
  17 ------------
  18
  19 * lots of example documentation can be found in the docu of template.py (:py:mod:`template`)
  20 * this Documentation was initialized using sphinx-quickstart
  21 * doc/conf.py can be used to configure lots of the documentation
  22 * the autodoc extension is responsible for creating .rst files from documentation in .py files
  23 * you should not have to change the my_module_name.rst files or modules.rst since they are auto-created
  24 * by including modules.rst in the toctree of index.rst, all modules' source doc is included in this help
  25 * in conf.py, there is a setup() function in the end which can be used to influence the doc strings
  26 * sometimes, adding . to the end of list items is required (not always as in this example)
  27
  28
  29 TODO
  30 ----
  31
  32 * before committing run pylint and pep8 (--> check.sh)
  33 * automatically get classes and exceptions (and free functions?) into sidebar when opening module doc
  34 * automatically set module name as title for module doc