Dashboard > Pylons Miscellaneous > Home > Doc as Windows compiled help file (chm)
  Pylons Miscellaneous Log In | Sign Up   View a printable version of the current page.  
  Doc as Windows compiled help file (chm)
Added by Andrew Smart, last edited by Andrew Smart on May 28, 2008
Labels: 
(None)

After playing around with epydoc and a epydoc-to-chm conversion script for my own projects (and getting acceptable results) I tried the same without any further preperation for the Pylons 0.9.6.1 / Webhelpers 0.3.2 versions I currently use.

I also did a try with paste but the resulting file was above 2 MB so I didn't want to flood the people here

See the result attached - not as good as my own doc's, but Pylons/Webhelpers is probably not that epydoc focused as my own source. Some things are missing (I'm also getting errors while compiling the chm file - missing links). Would need some further investigation why... I even had a epydoc crash for the webhelpers parts which needed some quick fixing at the epydoc source.

I don't know how many of you are Windows focused. What I find good with the chm files is the full text index and the full text search capability. There are linux viewers avaiable, so maybe even the Linux based developers would find this good.

Is there any interest for those chm files?

I could make a optimized Pylons+Paste+Webhelpers combination if people show interest.

Great job. I'd like to see the further work on this.

Posted by Anonymous at Jun 01, 2008 18:45 | Permalink | Reply To This
Site running on a free Atlassian Confluence Open Source Project License granted to Pylons. Evaluate Confluence today.
Powered by Atlassian Confluence, the Enterprise Wiki. (Version: 2.3.3 Build:#645 Feb 13, 2007) - Bug/feature request - Contact Administrators