Thanks for wanting to share your contributions, Dan.
> Got the trunk checked out of svn, but when I then ran install.py, it
> modified all the docs and configs, which is confusing the heck out of
> svn (svn status gives a host of !'s and M's).
The installer creates html files from phtml files by adding headers,
footers etc. and then deletes the phtml files which is the cause of the
!'s. If you want to keep the templates, then run install.py with the
--keep-templates option.
Besides that, the installer also adds header and footer to a few html
files created from ReST documents and modifies the Application.config
files. When doing development, you should revert these changes after
running install.py if you find that confusing.
The ReleaseProcedures document explains how to create the html files
from the ReST documents.
You may also want to have a look at the StyleGuidelines document.
In the long run, it would probably a good idea to support easy_install
instead of the Webware installer, but that is a bit of work because if
you want to do it right, you must probably replace the whole Webware
specific plug-in mechanism by conventional package installation (Chuck,
what do you think about that?).
By the way, this leads me to a general question: What is the standard
way and location for installing documentation for Python packages? I
have the impression that installing documentation is a neglected issue
in DistUtils and EasyInstall, or am I missing something?
-- Christoph
|