Differences between revisions 41 and 42
⇤ ← Revision 41 as of 2004-03-19 15:17:20 →
Size: 10102
Editor: FredDrake
Comment:
← Revision 42 as of 2004-03-31 14:07:46 → ⇥
Size: 10057
Editor: c207
Comment:
Deletions are marked like this. Additions are marked like this.
Line 2: Line 2:

PyConDC2004 is over. The Docutils BoF session saw about 20 people attending. I described the results of the sprint, then opened the floor for discussion. Got some good ideas. I'll post a summary here shortly.

See [http://starship.python.net/~goodger/pycon_dc_2004/ A Week at PyCon DC 2004] for a narrative account of events.
Line 6: Line 10:
We may also have a birds-of-a-feather session; see DocutilsBof. We also had a birds-of-a-feather session; see DocutilsBof.
Line 13: Line 17:
The sprints at ["PyConDC2004"] are to be held from March 20 (Saturday)
through March 23 (Tuesday), for a total of 4 days. I'm going to be there
for all 4 sprint days, so I invite sprinters to join in.  How long should the
Docutils sprint be? It depends on the participants and the other sprints.
How about separate Saturday/Sunday and Monday/Tuesday sprints?		 The sprints at ["PyConDC2004"] were held from March 20 (Saturday)
through March 23 (Tuesday), for a total of 4 days. I was there
for all 4 sprint days, and sprinters joined in as they were able.
Line 19: Line 21:
Please voice your opinions here or [mailto:goodger@python.org email me]. Please feel free to comment here or [mailto:goodger@python.org email me].
Line 24: Line 26:
There is no cost to attend the sprints beyond registering for Py``Con
(and being present, of course).		 There was no cost to attend the sprints beyond being present.
Line 30: Line 31:
Everyone is welcome! No prior Docutils hacking experience is required.
Participants should either be experienced Python programmers, or interested 		Everyone was welcome! No prior Docutils hacking experience was required.
Participants were either be experienced Python programmers, or interested
Line 34: Line 35:
Please [mailto:goodger@python.org email me] or
edit this page directly if you'd like to participate.		 Here are some of the sprinters who attended:
Line 46: Line 46:
 * Bill Sconce
 * Reggie Dugard
 * Lloyd Kvam
Line 50: Line 53:
This sprint and my participation at ["PyConDC2004"] are being sponsored by This sprint and my participation at ["PyConDC2004"] were sponsored by
Line 58: Line 61:
What would participants like to accomplish? Choose from among the
ideas below or add new ones. Register your votes below, and feel free
to comment.		 Each sprint day began with an interactive overview of the Docutils architecture and codebase.
Line 62: Line 63:
The sprint should begin with an introduction to Docutils and
reStructuredText: their purpose, future direction, and current
implementation. How long should it be? Should there be a long
preliminary lecture covering a lot of ground, or a minimal overview
(with the possibility of further dicsussions as needed)?

Here are ideas for the sprint, in no particular order:		 I will update this page with actual results from the sprint. For now,
here is the original list of ideas for the sprint, in no particular order:
Line 84: Line 80:
 * HTML fragment writer -- establish API (useful for ht2html and templating systems). ([http://docutils.sf.net/spec/notes.html#html-fragments Notes], and [http://docutils.sf.net/sandbox/oliverr/ht/ related work].) Fred Drake and Mike Orr are both interested in this.  * '''DONE''' HTML fragment writer -- establish API (useful for ht2html and templating systems). ([http://docutils.sf.net/spec/notes.html#html-fragments Notes], and [http://docutils.sf.net/sandbox/oliverr/ht/ related work].) Fred Drake and Mike Orr are both interested in this.

   Reggie Dugard implemented a new docutils.core.publish_parts() convenience function, with Mike Orr's initial help.

Preliminaries

PyConDC2004 is over. The Docutils BoF session saw about 20 people attending. I described the results of the sprint, then opened the floor for discussion. Got some good ideas. I'll post a summary here shortly.

See [http://starship.python.net/~goodger/pycon_dc_2004/ A Week at PyCon DC 2004] for a narrative account of events.

For introductory information and information about the other sprints going on at ["PyConDC2004"], please see SprintPlan2004.

We also had a birds-of-a-feather session; see DocutilsBof.

Also see the [http://docutils.sourceforge.net Docutils home page] and the [http://docutils.sourceforge.net/rst.html reStructuredText home page].

Duration

The sprints at ["PyConDC2004"] were held from March 20 (Saturday) through March 23 (Tuesday), for a total of 4 days. I was there for all 4 sprint days, and sprinters joined in as they were able.

Please feel free to comment here or [mailto:goodger@python.org email me].

Cost

There was no cost to attend the sprints beyond being present.

Sprinters

Everyone was welcome! No prior Docutils hacking experience was required. Participants were either be experienced Python programmers, or interested in documentation.

Here are some of the sprinters who attended:

Sponsorship

This sprint and my participation at ["PyConDC2004"] were sponsored by Silver Sponsor [http://WingIDE.com Archaeopteryx Software], the [http://www.python.org/psf Python Software Foundation (PSF)], and individual contributors. Thank you all!

Sprint Topic Ideas

Each sprint day began with an interactive overview of the Docutils architecture and codebase.

I will update this page with actual results from the sprint. For now, here is the original list of ideas for the sprint, in no particular order:

There are more ideas in the [http://docutils.sf.net/spec/notes.html#to-do Docutils to-do list].

Comments

Please feel free to add any comments you like. Include your name for feedback; anonymous comments OK too. I hope to see you at PyCon! -- David Goodger

I shan't be able to make PyCon (no surprise there), but I hope the sprint goes really well. I have no objection at all if one of the items of work is the pysource reader, whether based on my work or not - indeed, I'd love to see a working implementation out there. -- Tibs

I'd be very interested in working on the/a Python source code reader -- it seems like the giant missing piece of docutils. -- Ian Bicking

Two 2-day sprints would be better for me. I wasn't planning to attend any sprint, but Docutils is tempting me. I'd most likely attend Monday-Tuesday. I'm not that good at understanding intricate parser code, but perhaps I can work on some other aspect. My wishlist item is for the HTML generator to just produce an HTML fragment I can plug into a larger page, rather than all the header/footer/style stuff it adds. There has also been much interest in our local Python user group about having a ReST syntax in MoinMoin. -- Mike Orr

An enhanced client API with better support for [http://docutils.sf.net/spec/notes.html#html-fragments writing fragments] would be really nice to have; I'd be willing to spend some time on that as well. Each time I have tried to make a simple script that used docutils in some way, the API has been difficult to figure out. It may be that documentation is all that's needed, or just a more-visible entry point into existing documentation, but I know how hard that is to do. I think it would be worth having at least a little brain-storming session to figure out where people are getting hung up on the API and letting you tell us how much of it is there in some form already, and guiding an effort to make it more effectively exposed. Whether that's documentation, a little code, or a pile of new stuff, I don't know, but my past explorations make me think there's some limited amount of "API stuff" that needs to be done. It is unlikely I'll be able to sprint on this topic Monday/Tuesday though. -- Fred Drake

I'll probably be there for all four days. Anyone who's interested in automatic API documentation generation might want to take a look at EpyDoc, which currently supports reStructuredText. I'd like to work on extending it with better docutils support, and improve it in other ways. -- Edward Loper

I use EpyDoc quite a bit, and would like to help with it's docutils support. And, just in general, would like to help out the docutils project. -- Tracy Ruggles

I'd love to get the DocBook writer finished up -- I think it's pretty close. It needs tests, better bibliographic field handling, and probably a bit of polishing. -- Ollie Rutherfurd

DocutilsSprint (last edited 2015-01-10 12:15:15 by WolfgangMaier)

Unable to edit the page? See the FrontPage for instructions.