Mailman 3 October 2003 - Doc-SIG

Docutils autonumbered lists
by Dethe Elza Oct. 17, 2003

Oct. 17, 2003

Hi all, David, thanks for your reply to my last issue, we seemed to have solved it by having the requirements change underneath us... I'll try to find the place where the state machine seemed to be poking through (and dependant on file vs. StringIO). It had to do with how the include directive finds it's source directory. Of course, finding the source directory from a string (vs. a file) will be *problematic* in any case. %-) Today's issue is autonumbered lists. Since ordered lists autonumber themselves by default (in HTML), this seems like it would be easily accomplished, and I thought I remembered the notation: #. list item one #. list item two #. list item three But after trying it and going through the docs, I appear to have substituted footnote notation for list notation. Is there a clear and present reason why we don't do autonumbering for lists? What is the order of magnitude of the work needed to add it? I also wanted to share a success story. After proseletizing restructured text around the office, I finally gave up. Recently I was asked to implement a lightweight content repository and reST came up as a possible feature. So now we have a lightweight CMS with search integrated over both reST and Word documents (and our issue tracking and versioning systems), with portal-type templating, automatic reST processing, filesystem and webserver integration. It's been relatively straightforward, very successful, and now everyone in the office is learning to use reST. Thanks! --Dethe "Well I've wrestled with reality for thirty-five years now, doctor, and I'm happy to state I've finally won out over it." -- Elwood P. Dowd, Harvey

2 3

Docutils: Line block by default
by Dethe Elza Oct. 14, 2003

Oct. 14, 2003

One more docutils question. I want to set up an editing environment for my wife to organize her poetry. How would I go about processing restructured text so that it always behaves as if the line-block:: directive is in effect? TIA --Dethe "I started with nothing, and I still have most of it." -- Steven Wright

2 2

docutils issues
by Dethe Elza Oct. 8, 2003

Oct. 8, 2003

Hi folks, I'm trying to build a lightweight templating system around docutils. I'm using a (slightly modified, I use core.publish_file) version of Nicola Paolucci's recipe to create an HTML fragment from a reST file, which works fine as long as there are no errors. If there are errors, I want the option of allowing the error to be processed normally (resulting in an HTML fragment with embedded error messages) or throw an exception (so I can trap it and display the text instead). I've found that if the docutils processor is running on a file, I cannot get it to throw an exception all the way out to the calling method (it traps and processes it internally), while if I use a StringIO it causes exceptions that don't show up in the file processing. Docutils appears to be using the file object as it's state machine and calling methods which aren't part of the StringIO. Finally, if I use a StringIO, I have trouble with the include directive. If I can get core.publish_file (with a real file) to optionally throw an exception on error, I think that would be all I need. Failing that I need to teach core.publish_string (or core.publish_file with StringIO "file") to optionally *not* throw an exception *and* pass it a parameter for the relative path for include directives to work. Naturally, I'd prefer the first path. TIA --Dethe

2 1

Re: [Python-Dev] Documentation packages
by Gerrit Holl Oct. 3, 2003

Oct. 3, 2003

Hi, Fred L. Drake, Jr. wrote: > After a brief discussion on the Doc-SIG, it looks like I can > reasonably drop the .tar.gz packaging for the documentation, leaving > only .zip and .tar.bz2 formats. > > Are there any strong objections to this change? What is the reason to do so? Can it do any harm do leave it in? just curious... Gerrit Holl. -- 6. If any one steal the property of a temple or of the court, he shall be put to death, and also the one who receives the stolen thing from him shall be put to death. -- 1780 BC, Hammurabi, Code of Law -- Asperger Syndroom - een persoonlijke benadering: http://people.nl.linux.org/~gerrit/ Het zijn tijden om je zelf met politiek te bemoeien: http://www.sp.nl/

15 22

Distribution formats
by Fred L. Drake, Jr. Oct. 2, 2003

Oct. 2, 2003

We're currently distributing 21 different files for the documentation for a single Python release. This includes 3 compression formats for the HTML, LaTeX, PDF (2 paper sizes), and PostScript (2 paper sizes) formats, 2 compression formats for the GNU info, and 1 for the iSilo format. I'd like to cut back a little. ;-) Is there anyone currently relying on the gzipped archives who can't use the bzip2 archives? (How about the ZIP users? Can they rely on gzip or bzip2 archives?) I'd appreciate feedback on this. Thanks! -Fred -- Fred L. Drake, Jr. <fdrake at acm.org> PythonLabs at Zope Corporation

4 6