docutils-users

Re: [Docutils-users] Custom writer

[Stephan R.A. D. <sd...@wi...>]

From: "Patrick K. O'Brien" <po...@or...>:
> I'm wondering how hard it is to create a custom writer. In particular,
> one that produces a particular type of xml file. I've read all the
> docutils documentation and most of the emphasis seems to be on how to
> write text using RST, or what kind of HTML it produces. What I haven't
> seen much of is how to use RST for a particular application.

In case it helps, I managed to write my own custom writer in about a day
and a half of effort without any prior knowledge of docutils.  Might be
useful as an example of the minimum needed to glom onto the docutils
framework:

ftp://wingide.com/pub/outgoing/rest_writer.tgz
(http also works)

This and outputs plain text (often of course close to reStructuredText)
plus a list of link locations and targets.  This is used to feed into a
custom documentation viewer and besides is useful in outputting text
that's suitable to show to people that get freaked out by __ after words
and stuff like that.

It works on all the examples I've tried although the tables code isn't
done yet so outputs junk.

If this looks like something potentially useful for the docutils project,
please let me know and I can clean it up and contribute it.

- Stephan

------------------------------------------------------------------------
Wing IDE for Python                          Archaeopteryx Software, Inc
www.wingide.com                              Take Flight!

Re: [Docutils-users] Custom writer

[David G. <go...@py...>]

Stephan R.A. Deibel wrote:
> If this looks like something potentially useful for the docutils project,
> please let me know and I can clean it up and contribute it.

Haven't looked at the code yet, but it sounds very cool.  Yes, please, and
thank you!

-- David Goodger    go...@py...