[py-svn] r36641 - py/dist/py/documentation

[cfbolz at codespeak.net]

Author: cfbolz
Date: Sat Jan 13 13:24:56 2007
New Revision: 36641

Modified:
   py/dist/py/documentation/executables.txt
Log:
add docs for py.rest. explain the graphviz directive. I don't think much more
should be explained currently, it's too unstable.


Modified: py/dist/py/documentation/executables.txt
==============================================================================
--- py/dist/py/documentation/executables.txt	(original)
+++ py/dist/py/documentation/executables.txt	Sat Jan 13 13:24:56 2007
@@ -46,4 +46,19 @@
 ``py.rest``
 ===========
 
-XXX to be documented
+Usage: ``py.rest [PATHS] [options]``
+
+Loot recursively for .txt files starting from ``PATHS`` and convert them to
+html using docutils (or to pdf files, if the --pdf option is used).
+
+``py.rest`` has some extra features over rst2html (which is shipped with
+docutils). Most of these are still experimental, the one which is most likely
+not going to change is the `graphviz`_ directive. With that you can embed .dot
+files into your document and have them be converted to png (when outputting
+html) and to eps (when outputting pdf). Otherwise the directive works mostly
+like the image directive::
+
+    .. graphviz:: example.dot
+       :scale: 90
+
+.. _`graphviz`: http://www.graphviz.org