Mailman 3 October 2009 - Doc-SIG

Re: [Doc-SIG] greetings from new volunteer and question about documentation needs
by Serdar Tumgoren Oct. 14, 2009

Oct. 14, 2009

Ralf, Many thanks for the response. I'm planning to take your advice and look for a project or two of interest. Something database-related would indeed be high on my list. Thanks again! Regards, Serdar

1 0

greetings from new volunteer and question about documentation needs
by Serdar Tumgoren Oct. 14, 2009

Oct. 14, 2009

Hi everyone! I'm new to the Python volunteer community, and another member suggested that helping out with documentation is a great way to get started. A bit of background on me: I'm a journalist who recently made the shift to full-time database work for Congressional Quarterly, a news organization based in Washington, D.C. I started dabbling with Python two years ago, and now have the good fortune to use it daily in my work. Python and its community have helped me enormously, so I figured it's time to give something back. I've started reading the style guide for documentation writers, but I wasn't able to dig up a list of projects or priorities that need doing. Is there such a list? If not, should we start one on the doc-sig page of the Python wiki? http://www.python.org/community/sigs/current/doc-sig/ For me, such a list would help focus my efforts on the genuine needs of the community. And it could help others who'd like to contribute but are not sure where to begin. So please let me know what you think about the idea of a priority list, or better yet, reply back with specific project ideas or needs. And of course, if such a list already exists, just point me to it. I'll be happy to help out. Regards, Serdar Tumgoren

2 1

Docutils 0.6 released
by grubert＠users.sourceforge.net Oct. 12, 2009

Oct. 12, 2009

Good morning, Release 0.6 is out. Changes are : * Two new writers for ODT and manpage (so there is no excuse for python software not having a manpage anymore). * Python2.2 is no longer supported. Release 0.6 is compatible with Python versions from 2.3 up to 2.6 and convertible to 3.1 code. * The "newlatex" writer is orphaned. * The LaTeX2e writer sports templates now and is the most active worked on part. There might be some suprises due to new defaults, but we tried to minimize breakage and choose sensible defaults. * The HTML writer supports a comma separated list of stylesheets. * Some changes to reStructuredText many thanks to all contributors. have a nice start into a new week. engelbert

1 0

Request for Eyeballs: Python Project Howto
by John Kleint Oct. 1, 2009

Oct. 1, 2009

I'm writing an introduction to releasing open-source Python projects. Having recently gone through it for the first time myself, I was amazed at how far and wide I had to range to pull together all the information that goes into making a good Python package. So I thought I'd write it up and share: http://infinitemonkeycorps.net/docs/pph/ It's tentatively called the "Python Project Howto," and it's aimed at people who, though not necessarily new to Python, may be new to packaging and possibly open source. It tries to be succinct and practical, demonstrating by example. It covers choosing project hosting, setting up version control (Subversion basics), code quality (Pylint) and style (PEP 8), documentation (reStructuredText, Sphinx), unit testing (doctest and unittest), licensing, packaging (distutils), and release (PyPI). One thing I don't want it to be is an exhaustive list of all the possibilities for each of those areas. For instance, I cover reStructuredText and Sphinx, but not epydoc; distutils but not setuptools. I've tried to pick the simplest, most common among several options, and sometimes provided a link to others (pip, nose). I'm trying to Keep It Simple for people just dipping their toes into the Python ecosystem. I'd really like to know what people think; it would be great to get some feedback on it. Thanks! -John

3 4