Using reST (reStructuredText) to create HTML snippets (Python recipe) by Nicola Paolucci

ActiveState Code (http://code.activestate.com/recipes/193890/)

Is it version 0.2? I tried your tip. But not runned well. So I wrote corresponded to version 0.2 tip. See also below code.

-- begin code.

from docutils import core
from docutils.writers.html4css1 import Writer, HTMLTranslator
from docutils.readers.standalone import Reader
from docutils.parsers.rst import Parser

class NoHeaderHTMLTranslator(HTMLTranslator):
    def __init__(self, document):
        HTMLTranslator.__init__(self, document)
        self.head_prefix = ['','','','','']
        self.body_prefix = []
        self.body_suffix = []
        self.stylesheet = []

class Publisher(core.Publisher):
    def publish(self, data):
        self.set_options()
        self.options.stylesheet = ''
        self.options._destination = ''

        parser = Parser()
        reader = Reader(parser, None)
        writer = Writer()
        writer.translator_class = NoHeaderHTMLTranslator
        iodata = core.io.StringIO(self.options, source=data)
        xmldata = reader.read(iodata, parser, None)
        xmldata.options = self.options
        return writer.write(xmldata, iodata)

def reSTify(s):
    return Publisher().publish(s)

if __name__ == '__main__':
    test = """
Test example of reST__ document.

__ http://docutils.sf.net/rst.html

- item 1
- item 2
- item 3

"""
    print reSTify(test)

-- end of code.

So generate below HTML.

<div class="document">
<p>Test example of <a class="reference" href="http://docutils.sf.net/rst.html">reST</a> document.</p>
<ul class="simple">
<li>item 1</li>
<li>item 2</li>
<li>item 3</li>
</ul>
</div>

Hmm, I had mistake. I had a mistake. It seems that I downloaded the older thing.

It corrects. It seems that that is not right although considered. Your tip will operate, if it is somewhat old CVS revision.

Easier method for using ReST. A disadvantage of the method posted above is that it preserves the header while stripping it of context. Items that would be rendered as h1 in ReST also get rendered as title.

The function that finally writes out the page is the astext function. In the normal version, a bunch of lists are concatenated together, but we only care about the self.body list for our snippet. Thus we can avoid modifying any initialization steps and instead override the astext function, making our modification much simpler :

class NoHeaderHTMLTranslator(HTMLTranslator):
    def astext(self):
        return ''.join(self.body)

The rest of the recipe remains the same.

Controlling class. And if you add

def visit_document(self, node):
    self.body.append(self.starttag(node, 'div', CLASS='whatever'))

to the NoHeaderHTMLTranslator class, you can control the div class. "document" is a bit awkward if you only include snippets.

Official API now exists. There's now an official API (in CVS, as of version 0.3.2) that does this: docutils.core.publish_parts() (see the docstring for details). There's also a new module, docutils.examples, that exposes practical examples of Docutils client code, to be used as-is or as models for variations.

A development snapshot is always available here:

http://docutils.sf.net/docutils-snapshot.tgz