Generate documentation from Python sources by pydoc.
authorOleksandr Gavenko <gavenkoa@gmail.com>
Wed, 04 Jan 2012 00:22:34 +0200
changeset 1190 26fd684df3ee
parent 1189 78104ca7c163
child 1191 764705e790cb
Generate documentation from Python sources by pydoc.
python.rst
--- a/python.rst	Tue Jan 03 13:26:20 2012 +0200
+++ b/python.rst	Wed Jan 04 00:22:34 2012 +0200
@@ -14,7 +14,7 @@
 ======================================
 ::
 
-  $ python -m compileall dir
+  $ python -m compileall $dir
 
 Install python modules/packages.
 ================================
@@ -33,6 +33,23 @@
   http://peak.telecommunity.com/DevCenter/EasyInstall#uninstalling-packages
                 Uninstalling Packages
 
+Generate documentation from Python sources.
+===========================================
+
+Generate documentation from Python sources by pydoc.
+----------------------------------------------------
+::
+
+  $ mkdir html
+  $ cd html
+  $ pydoc -w ../
+
+Generate documentation from Python sources by epydoc.
+-----------------------------------------------------
+
+Generate documentation from Python sources by Sphinx.
+-----------------------------------------------------
+
 Code analyzers and style checkers.
 ==================================