PyXR Readme file


PyXR generates pretty-printed HTML from python source files. The generated web pages have extensive cross-referencing hyperlinks.

New Features for Release (01 Jan 2005 14:46:44 +0000)

Basic Installation

Using PyXR

Trying out the app

PyXR was designed to generate static html pages that are in turn served up by your platform's webserver (IIS, apache, etc). However, there is a testbed server that you can use if you want to try PyXR before generating serveral megs of output. Simply run "python" from the PyXR directory. This will perform initialization of the index (which will take a few minutes) and start a webserver at http://localhost:8088/ that will server 100 pages. This builds the webpages without any caching, so it'll take a few seconds to generate each page as you're browsing.

Generating Static pages

If you've tested the app, and decided that you like it, you'll probably want to generate static output. To do so, just run 'python' from the PyXR directory. [You may want to review the settings configuration section before doing this]. Ten to twenty minutes later, you should have a full copy of the source on your server. Scheduling a nightly automated job is left as an exercise for the reader.

Integrating the Library Reference

Library Reference isn't integrated by default because the .html documents can exist in a variety of locations on any given platform. Once you have the documentation installed, set useLibraryReference to 1 in settings.cfg and set the libUrl and libDirectory appropriately. These should point to the 'lib' subdirectory and not the 'doc' directory. Example:
useLibraryReference = 1
libDirectory = c:\inetpub\wwwroot\python23doc\lib\
libUrl = /python23doc/lib/

Generating a cached data file

Either of the above options has an initialization phase that can take serveral minutes. They can accept an optional parameter that points to a cached data file. This will speed things up in development (or if for some reason you just can't run due to capacity issues). Running "python filename" will generate the file. After it's been generated, "python filename" or "python filename" will utilize it. Just remember not to edit any of your .py files if you're doing this ;)

ToDo- the future

Not ToDo (so don't ask)

Questions? Comments? Critisisms?

logistix at Logo