From goodger at python.org Tue Oct 5 04:10:55 2004 From: goodger at python.org (David Goodger) Date: Tue Oct 5 04:45:32 2004 Subject: [Doc-SIG] line block syntax added to reStructuredText Message-ID: <416202AF.4070004@python.org> 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 -------------- next part -------------- A non-text attachment was scrubbed... Name: signature.asc Type: application/pgp-signature Size: 253 bytes Desc: OpenPGP digital signature Url : http://mail.python.org/pipermail/doc-sig/attachments/20041004/f59d5473/signature.pgp From mike at pcblokes.com Fri Oct 22 01:51:25 2004 From: mike at pcblokes.com (Michael Foord) Date: Fri Oct 22 01:37:40 2004 Subject: [Doc-SIG] Docutils and ResT Message-ID: <41784B7D.6080105@pcblokes.com> 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 From goodger at python.org Fri Oct 22 02:41:45 2004 From: goodger at python.org (David Goodger) Date: Fri Oct 22 02:47:35 2004 Subject: [Doc-SIG] Docutils and ResT In-Reply-To: <41784B7D.6080105@pcblokes.com> References: <41784B7D.6080105@pcblokes.com> Message-ID: <41785749.4000200@python.org> [Michael Foord] > I hope progress is being made on pysource Yes, I'm working on it now. You can expect something before long. > 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. There's an interface that does exactly that. See for a brief overview. You want the ``publish_parts`` function. > 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. What kind of directives? (Directives are added to the parser, not the reader. See PEP 258 for an overview.) > I am hoping that people won't object to me posting questions here > about this.... No objections. That's what here is for! The docutils-develop list is also available. > 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 One suggestion: that page would look a lot better if the stylesheet were installed on the site. -- David Goodger -------------- next part -------------- A non-text attachment was scrubbed... Name: signature.asc Type: application/pgp-signature Size: 256 bytes Desc: OpenPGP digital signature Url : http://mail.python.org/pipermail/doc-sig/attachments/20041021/3b523e76/signature.pgp From mike at pcblokes.com Fri Oct 22 14:57:26 2004 From: mike at pcblokes.com (Voidspace) Date: Fri Oct 22 14:57:30 2004 Subject: [Doc-SIG] Docutils and ResT In-Reply-To: <41785749.4000200@python.org> References: <41784B7D.6080105@pcblokes.com> <41785749.4000200@python.org> Message-ID: <417903B6.40807@pcblokes.com> Hello David, David Goodger wrote: > [Michael Foord] > > I hope progress is being made on pysource > > Yes, I'm working on it now. You can expect something before long. Brilliant. Docutils is *very* good - I really appreciate being able to use ResT. Docfactory will be nice as well - for some reason I was getting slightly different (not so good) output from Docfactory than from buildhtml.py - which I thought was odd. > > > 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. > > There's an interface that does exactly that. See > for a brief overview. > You want the ``publish_parts`` function. Aha... fantastic Very interesting. > > 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. > > What kind of directives? > > (Directives are added to the parser, not the reader. See PEP 258 for > an overview.) Ok - thanks. That gives me a good start. When I run into difficulties I'll let you know :-) (I'm sure you're delighted to hear that). The sort of things I'm hoping to add are : a display box auto generate indexes from the contents of directories - so need a meta description in each page and a directive to generate the index images in different 'classes' so I can apply different styles (left, centered and right basically) > > I am hoping that people won't object to me posting questions here > > about this.... > > No objections. That's what here is for! The docutils-develop list is > also available. Ok - might be more appropriate. > > > > 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 > > One suggestion: that page would look a lot better if the stylesheet > were installed on the site. > Isn't it ?? Should be - oops............ Thanks for your answers and help - much appreciated. Regards, Michael -- http://www.Voidspace.org.uk The Place where headspace meets cyberspace. Online resource site - covering science, technology, computing, cyberpunk, psychology, spirituality, fiction and more. --- http://www.Voidspace.org.uk/atlantibots/pythonutils.html Python utilities, modules and apps. Including Nanagram, Dirwatcher and more. --- http://www.fuchsiashockz.co.uk http://groups.yahoo.com/group/void-shockz --- Everyone has talent. What is rare is the courage to follow talent to the dark place where it leads. -Erica Jong Ambition is a poor excuse for not having sense enough to be lazy. -Milan Kundera From goodger at python.org Fri Oct 22 15:45:07 2004 From: goodger at python.org (David Goodger) Date: Fri Oct 22 15:51:33 2004 Subject: [Doc-SIG] Docutils and ResT In-Reply-To: <417903B6.40807@pcblokes.com> References: <41784B7D.6080105@pcblokes.com> <41785749.4000200@python.org> <417903B6.40807@pcblokes.com> Message-ID: <41790EE3.9070301@python.org> [Michael Foord] > for some reason I was getting slightly different (not so good) > output from Docfactory than from buildhtml.py - which I thought was > odd. It could be a stylesheet issue. HTML with the stylesheet looks a lot better than without. > The sort of things I'm hoping to add are : > > a display box Can you elaborate? > auto generate indexes from the contents of directories - so need a > meta description in each page and a directive to generate the index What kind of index? Are you thinking of a simple list (like a table of contents), or a detailed index (like in the back of a reference book)? > images in different 'classes' so I can apply different styles (left, > centered and right basically) You can do that now: .. image:: picture.png :class: right The "class" option is directly transferred to a "class" attribute on an HTML tag, so all you have to do is add corresponding styles to your stylesheet. Details here: . > Thanks for your answers and help - much appreciated. You're welcome. -- David Goodger -------------- next part -------------- A non-text attachment was scrubbed... Name: signature.asc Type: application/pgp-signature Size: 256 bytes Desc: OpenPGP digital signature Url : http://mail.python.org/pipermail/doc-sig/attachments/20041022/111f1163/signature.pgp