Prev Next | Back Along | Up Home

html.py

Reader:Standalone
Parser:reStructuredText
Writer:HTML

The html.py front end reads standalone reStructuredText source files and produces HTML 4 (XHTML 1) output compatible with modern browsers. For example, to process a reStructuredText file "test.txt" into HTML:

html.py test.txt test.html

In fact, there is a "test.txt" file in the "tools" directory. It contains "at least one example of each reStructuredText construct", including several intentional errors (to test the error reporting system). Use it to put the system through its paces and compare input to output.

Now open the "test.html" file in your favorite browser to see the results. To get a footer with a link to the source file, date & time of processing, and links to the Docutils projects, add some options:

html.py -stg test.txt test.html
Prev Next | Back Along | Up Home