Doc-SIG

Download

doc-sig@python.org

October 2004

2 participants
2 discussions

Docutils and ResT
by Michael Foord Oct. 22, 2004

Oct. 22, 2004

Hello, I'm a very recent, but appreciative, convert to Docutils and ResT. I'm gradually converting my docstrings and module documentation to ResT. I hope progress is being made on pysource - to be fair epydoc is pretty good though. Anyway - enough waffle. I'd like to convert docutils to emit *part* of an html page. This is so that I can also write a preprocessor and develop an automatic content management system for my website. This will allow me to do all the content for my website in ResT rather than HTML - hurrah. This end of the project is simple enough - I can modify the HTML writer to not do the head and tail of the page. I'd also like to extend ResT a bit to add a few directives, so I'll need to tinker with the reader which looks a bit more complex. I am hoping that people won't object to me posting questions here about this.... [I'd like to auto generate index pages and few other interesting bits and pieces] Yours, hopefully not too annoyingly... Michael Foord p.s. If anyone is vaguely interested in my ideas I kind of summarised them at : http://www.voidspace.org.uk/documents/voidspace_manifesto.html voidspace is badly in need of a revamp *sigh* - XHTML and CSS here I come.... http://www.voidspace.org.uk/atlantibots/pythonutils.html

3 3

line block syntax added to reStructuredText
by David Goodger Oct. 5, 2004

Oct. 5, 2004

I just added code for the new "line block" syntax to the parser. Docs, tests, Docutils support, and HTML writer support also added. The structure of line blocks has changed. The old "line-block" directive is now marked as deprecated, and the directive itself now produces the new structure. This may pose a problem for users of LaTeX and other output formats. I hope that they can be updated quickly. If not, we can temporarily produce both old and new structures depending on context, but I'd rather avoid that if possible. docs: http://docutils.sf.net/docs/ref/rst/restructuredtext.html#line-blocks demo: http://docutils.sf.net/docs/user/rst/demo.html#line-blocks CVS snapshot: http://docutils.sf.net/docutils-snapshot.tgz -- David Goodger <http://python.net/~goodger>

1 0