[Pythonmac-SIG] Need help debugging Python documentation install
Jack Jansen
Jack.Jansen@oratrix.com
Wed, 28 Aug 2002 23:41:15 +0200
Folks,
I just checked in a couple of things that allow you to create a
version of the Python
documentation that is viewable from Apple Help Viewer and
Project Builder.
Special thanks go to Bill Fancher, who created the script to
make this all work.
Now, however, I need to debug the way I'm installing the
documentation, and I can't do that myself, because it seems that
once you've told Apple help Viewer about a documentation set
there is absolutely no way to make it forget that documentation
again, so my system is tainted.
Here's the setup of things:
- There's a script Mac/OSX/setupDocs.py. Call "python
setupDocs.py build" to build the documentation, wait until the
Help indexing tool is done, then call "python setupDocs.py
install". For the moment, for testing purposes, this will
install the 2.2.1 documentation. The script should only be used
with a framework Python, and it will install the docs in the
framework (in Resources/English.lproj/Documentation).
- This is good enough for Project Builder (although the
documentation does not show up in the help window it is viewable
if you add Python.framework to your project and then open the
reveal triangle of Python.framework). It isn't good enough for
Help Viewer, though, it wants the documentation to be referred
to from a .app bundle. For this reason Python.app contains the
magic words in its Info.plist file, and has a symlink
Resources/English.lproj/Documentation that points to the
location above.
Now, all this may be good enough, and it may not be, and I can't
test it anymore. If someone could do the following:
- cvs update
- make frameworkinstall
- python setupDocs.py build
- python setupDocs.py install
- Run a script with Python.app, something that stays open for a
while so you can see the menu bar. Something like
import EasyDialogs
EasyDialogs.Message("Hello World")
should do the trick.
- Check whether there's a help menu, and whether the "Python
Help" entry will open the Python docs in help viewer.
- Open Help Viewer manually and check whether the Python
documentation is mentioned in the index page.
- Report your findings back here.
--
- Jack Jansen <Jack.Jansen@oratrix.com>
http://www.cwi.nl/~jack -
- If I can't dance I don't want to be part of your revolution --
Emma Goldman -