[Nut-upsdev] RST conversion of NUT documentation

[Charles Lepple]

Arnaud mentioned the RST conversion in his 2.2.1 announcement email,
and the following is an update on what's happening.

As you can see in r1195 of trunk/README, RST is a lightweight markup
on top of plain text.

The main source of information on RST (short for ReStructuredText) is
here: http://docutils.sourceforge.net/rst.html

I am volunteering to do the conversion of the documentation, but
before we go wild in that direction, we should probably discuss how we
can simplify the documentation somewhat. (That's the topic of another
email.)

Attached is the gzipped output of running the following command:

  $ rst2html.py README > README.html

I will try to figure out a good way to integrate this into our build
system, but if you have any suggestions, I'd be happy to hear them.

You can find rst2html.py in the docutils package. There is a similar
version for LaTeX output, which can yield PDF files suitable for
printing.

A good way to figure out how to add RST formatting to new documents is
to compare the source and output of the ReStructuredText primer:

 * http://docutils.sourceforge.net/docs/user/rst/quickstart.txt

 * http://docutils.sourceforge.net/docs/user/rst/quickstart.html

Another way is to paste it into a Trac instance which has RST enabled
on the wiki pages. (Contact me off-list if you would like a login to
the unofficial NUT Trac site.)

-- 
- Charles Lepple
-------------- next part --------------
A non-text attachment was scrubbed...
Name: README.html.gz
Type: application/x-gzip
Size: 12232 bytes
Desc: not available
Url : http://lists.alioth.debian.org/pipermail/nut-upsdev/attachments/20071226/a6f1fdee/attachment.bin