SYNOPSIS
use Pod::HtmlTree qw(pod2htmltree);
pod2htmltree($httproot);
So you've just created a great new Perl module distribution including several *.pm files? You've added nice POD documentation to each of them and now you'd like to view it nicely formatted in a web browser? And you'd also like to navigate between all those manual pages in your distribution and even view their source code? Read on, Pod::HtmlTree is what you need.
It traverses your module's distribution directory (which you've probably created using h2xs), finds all *.pm files recursivly and calls pod2html() on them, hereby resolving all POD links (L style).
Patching SEE ALSO and WHERE'S THE SOURCE?
It then saves the nicely formatted HTML files under docs/html and updates each's SEE ALSO section to contain links to every other *.pm file in you're module's distribution. So, if you want that, please make sure your documentation contains a SEE ALSO section.
Also, at the end of the SEE ALSO section, it'll add a link to the source code of the current *.pm file, just in case a user wants to browse it because there's issues which aren't clear from the documentation.
It also adds a stylesheet to docs/html, which is referenced by every HTML file.
So, in order to obtain HTML documentation for all your distribution's files, just call the script (which comes with the distribution of this module)
pod2htmltree httproot
while you're located in the top directory of your module's distribution. What's in httproot is explained below.
The script pod2htmltree just calls
use Pod::HtmlTree;
Pod::HtmlTree::pod2htmltree($ARGV[0]);
internally, if you want to call it from within Perl, that's the way to go.
Product's homepage
Requirements:
· Perl
Find us on Google+
