[Python-Dev] [ANN] Python documentation team looking for members!
g.brandl at gmx.net
Sat Jul 21 12:28:28 CEST 2007
Dear fellow Pythonistas,
as you may have heard, Python is going to get a new documentation system
soon . As part of that effort, and in order to maintain the excellent
quality of the docs, we are looking for members of the maintainers team.
This is your chance to get involved with Python development!
There will be two main objectives of the group, or maybe two subgroups can
* Maintaining the documentation contents:
- processing user submitted comments, bugs and patches
- helping out developers with docs-related matters, keeping an eye
on commits to ensure quality
- keeping the docs up-to-date, e.g. write new sections for new
Python 3000 features
The docs source will be in reStructuredText, which is already known to a
relatively high percentage of Python developers.
The new online version of the docs will contain features to add comments
and suggest changes, so it is expected that there will be some amount
of user involvement.
* Development of the toolset:
- fixing bugs in the package
- adding new output formats, e.g. info or pdf
- adding new features to the web application
- adapting it to new docutils features
The software is written in pure Python. It is currently located in the
docutils Subversion repository, at
The README file gives you a rough idea what you find there and how to
get started, all other questions can be directed to georg at python.org,
I'll answer them gladly.
An additional objective in the near future will, of course, be handling the
switch to the new system.
Okay, so you've read until here? And you're interested in joining the team?
Wow! Write to the docs at python.org and become a documentation maintainer!
 see http://pyside.blogspot.com/2007/06/introducing-py-rest-doc.html
for some details, and http://pydoc.gbrandl.de:3000/  for a demo.
(Commenting doesn't work yet, but it's worked upon fiercely...)
 the demo server is a small vserver with the application served by a
single wsgiref instance, and as such not fit to handle large amounts
of requests, so it may well be that you don't get good reponse times.
Thus spake the Lord: Thou shalt indent with four spaces. No more, no less.
Four shall be the number of spaces thou shalt indent, and the number of thy
indenting shall be four. Eight shalt thou not indent, nor either indent thou
two, excepting that thou then proceed to four. Tabs are right out.
More information about the Python-Dev