[Checkins]
SVN: Sandbox/ulif/grok-reference-with-rest2/doc/grokref/README.txt
Updated README.
Uli Fouquet
uli at gnufix.de
Sun Jan 6 10:28:39 EST 2008
Log message for revision 82689:
Updated README.
Changed:
U Sandbox/ulif/grok-reference-with-rest2/doc/grokref/README.txt
-=-
Modified: Sandbox/ulif/grok-reference-with-rest2/doc/grokref/README.txt
===================================================================
--- Sandbox/ulif/grok-reference-with-rest2/doc/grokref/README.txt 2008-01-06 15:25:35 UTC (rev 82688)
+++ Sandbox/ulif/grok-reference-with-rest2/doc/grokref/README.txt 2008-01-06 15:28:39 UTC (rev 82689)
@@ -50,17 +50,20 @@
After running ``buildout`` in the grok ``bin`` directory, there should
be a new script called ``grokref2html``. This script can be called
-with a source file or directory as argument::
+with a ReST source file as argument::
- $ bin/grokref2html doc/reference
+ $ bin/grokref2html doc/reference/index.rst
-or::
+This will ouput HTML to the commandline (subject to change).
- $ bin/grokref2html doc/reference/core.rst
+Run::
-This will ouput HTML to the commandline (subject to change).
+ $ bin/grokref2html --help
+for a complete list of available options.
+
+
How do I write reference documentation?
---------------------------------------
@@ -166,5 +169,6 @@
Note, that you also need a ``translator`` to translate the special
entitites supported by grokref into your special output format. Some
-examples can be found in ``translators.py`` in this directory.
+examples can be found in ``translators.py`` in the `extensions`
+directory.
More information about the Checkins
mailing list