Help System Works Again

3 views

Skip to first unread message

Kris Kowal

unread,

Dec 12, 2008, 7:01:08 PM12/12/08

to Chiron

The help system works again in the latest builds. You can call help
on any function exported by a module and get a description of the
function built from its comment docs.

http://modulesjs.com/nightly/chiron-r398/run.html

>>> help(help)

This only works for builds. I revamped the build system a couple days
ago. Parts of the build process require java (for YUICompressor) and
Python's docutils (for converting the JavaScript docs from RST to
HTML). Everything else, like Python, Bash, and Gzip, are pretty much
on every Unix system. Windows does need to be addressed at some
point. The next step is to create a package management system. The
current build includes 241 modules that I've created (some) or ported
(most).

The build process does a lot of work that is required for any real
production deployment. It creates the documentation, glossary, help
files, and YUI compresses, bundles, and gzips all of the content. It
would be good to get some feedback on usability.