Just Launched: You can now import projects and releases from Google Code onto SourceForge
We are excited to release new functionality to enable a 1-click import from Google Code onto the Allura platform on SourceForge. You can import tickets, wikis, source, releases, and more with a few simple steps. Read More
From: Dan Milstein <danmil@co...> - 2006-09-15 15:34:49
I'm interested in doing some development work on Webware (I added a
feature to my own install of 0.8.1, and now I'd like to port it to
the trunk version, and then send it around to this list for
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).
What's the theory of working on the Webware source code, in terms of
the relationship between svn and install.py?
In an ideal world, I'd like to be able to modify the source code,
test it against an app, and, when I run svn status, just see the
modifications I've made showing up.
I can run MakeAppWorkDir, which is a good start (since it'll put
configs and apps somewhere else), but that will still leave all the
docs in a non-svn state, right? Should I just not build the docs and
How do folks work around this?
From: Christoph Zwerschke <cito@on...> - 2006-09-15 16:12:32
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
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?