The Docutils sprint at PyConTX2006 was held over 4 days, from 9:00 Monday February 27 through Thursday March 2 inclusive. There was no cost to attend the sprints beyond being present at PyCon. For introductory information and information about the other sprints going on at PyConTX2006, please see PyCon2006/Sprints. Also see the Docutils home page and the reStructuredText home page. The PyCon DC 2004 Docutils sprint details are here: DocutilsSprint.
Please feel free to add your comments here (prefered); I'll be notified of all changes to this page. If you can't edit the wiki, you can email me.
If you cannot attend the Docutils sprints in person but would still like to follow the progress and/or participate, you can, via Internet Relay Chat (irc.freenode.net, channel #docutils).
Everyone is welcome! No prior Docutils hacking experience is required. Participants should be one or more of:
- experienced Python programmers
- interested in text/documentation processing
- users of Docutils/reStructuredText
Sprinters planning to attend:
- David Goodger (coach)
- Felix Wiemann
- Thomas Drake (Monday, Tuesday, Wednesday)
- firstname.lastname@example.org (I'm ready anytime but I am on WinXP in Singapore Internet cafe)
- John Gill (Monday, Tuesday)
- Facundo Batista
Please add your name to the list above or email me.
Things that we may need to think about when adding nested inline markup:
`foo :bar:`/baz` qux` (inline start-string probably takes priority) ***foo** bar* ***foo* bar** ******************************foo******************************
The inline parser must determine whether a role contains literal or parsed text before it starts parsing the contents:
:raw:`This *contains ``uninterpreted `markup`
We probably have to disallow (or at least deprecate) postfix notation for literal (or for all) roles, because of this:
`contents`:raw: // This happens to work `This *contains ``uninterpreted `markup`:raw:
In the latter case, the parser cannot know at the time it parses the role contents that they are literal
Other projects with plugin mechanisms:
We will begin the sprint with an interactive overview of the Docutils architecture and codebase. Then we will determine sprint topics and get hacking! Sprinters are free to work alone, work in pairs (pair programming), or however they feel comfortable.
The topics below are in no particular order. Please feel free to add topics & comments.
- Python source reader (autodocumentation subsystem). Ideas:
- Writers (output formats):
- DocPy (Python's dialect of LaTeX) writer completion. This would allow easier entry for documentation newbies, and "make authorship more accessible" (initial implementation).
- OpenDocument writer.
- DocBook writer (initial implementation in Oliver Rutherfurd's sandbox)
- RTF writer
- Large document issues, including formal elements
- Nested inline markup
- Math markup.
- Complete "The Docutils Document Tree" reference.
- Squash bugs!
- Add internationalization to footer boilerplate text.
- Adaptable file extensions.
There are more ideas in the Docutils to-do list.