Generating release announcements

The pyauto script can generate release announcements to be mailed to gnome-announce-list@gnome.org.

python pyauto.py -e

The announce.pyauto template is filled with information about LSR from this wiki and the NEWS file in CVS. The configure.in file is groked for the release version number.

Updating documentation

Note: epydoc building will be integrated into the make process at some point.

The docstrings in the LSR Python source follow the epydoc format. The epydoc library for Python can read these strings and produce HTML or PDF documentation. While epydoc does a decent job of finding module dependencies via imports, it still needs help finding all of the LSR source files and must be provided with a list of all the files containing docstrings.

The pyauto script can automate the production of HTML documentation. First, download the epydoc source and install it. (Don't use the RPM linked off the epydoc webpage. It's faulty as of 7/7/05.)

tar xzf epydoc-2.1.tar.gz
su root
cd epydoc-2.1

There is a bug in this release. Edit line 2179 in the html.py file so that it reads:

if (self._inheritance != 'grouped' and inherited):

The change is the _ed_ at the end of _inherited_. Then finish the install by doing:

python setup.py install
exit

After installing, run pyauto as follows:

python pyauto.py -d

All errors encountered the epydoc parser will be reported to stderr. Problems with modules outside of LSR can be safely ignored. Unless epydoc raises an exception, it will continue processing the source and produce its output in the doc folder.