Auto-generated project docs
August 19, 2005
I used to have to go through the process of rendering XHTML versions of the manpages for my projects (most notably sl and ggtl) every time I made any change to them.
Not so anymore! I now use SVK modules to pull the source directly from the subversion archive and Pod::Xhtml to render the documentation into XHTML. The only downside is that if I move files in the subversion repository, I’ll have to update the site to make sure we’re pulling in the files from the right place.
As a side effect, this allowed me to strip a lot of text from my site, as shown by this diffstat:
css/site.css | 9
software/ggtl/doc/autohandler | 5
software/ggtl/doc/ggtl-nim.html | 110 -------
software/ggtl/doc/ggtl-reversi.html | 201 -------------
software/ggtl/doc/ggtl.html | 542 ------------------------------------
software/ggtl/doc/reversi-demo.html | 88 -----
software/pod.mas | 22 +
software/sl/doc/index.html | 138 ---------
8 files changed, 41 insertions(+), 1074 deletions(-)
The CSS additions were necessary to keep the same look as before (Pod::Html does slightly different markup, but won’t accept string input or give string output, so I saw it necessary to change).
Long live CPAN!
Leave a Reply