Geek Answers Handbook

Convert all PODs from a given namespace to one large HTML page

Several times you need to consult with the documents. Some (larger) systems consist of many packages and containers, and it is not always clear where this method is described, for example. it is located in Pgk::Reqor in Pkg::Utils, etc .... It really takes a lot of time and it is terribly boring to look for the right POD to describe this method .; (

Therefore, we are looking for a way to convert the entire POD from a given namespace, for example. Some::Pkg::to one large HTML page.

I don’t need any fancy cross-linking or such - only one large formatted html page where I can quickly find a description of the method you need. I don't care about page size - I just want to get one readable page.

I tried looking at many POD-like modules in Metacpan - but I did not find any module, which can be done above. In short, something like:

make_bigpod CHI::* >one_big.html
# and will get ALL docs for CHI.pm and CHI/*.{pm,pod} into one big page

Any suggestion how?

+4
source share
3 answers

The perldoc page is maintained by John Allen. He has a Perldoc server, which you can use to create a web page, such as a perldoc site, but using your code and module. It includes a search area, as well as syntax highlighting and indexes.

http://search.cpan.org/~jonallen/Perldoc-Server-0.10/lib/Perldoc/Server.pm

, html , ...

(TIMTOWTDI) script .pm , ( perldoc http://search.cpan.org/dist/Pod-Perldoc/), html .

+1

html , Pod::HTML. pod2html, - :

cat $(find ~/path/to/packages -type f -print | grep -E 'NameSpace.*\.(pm|pod)') | pod2html --quiet > all.html

all.html NameSpace. , .

+1

, perldoc search.cpan.org?

perldoc man page: http://perldoc.perl.org/perldoc.html

-1

More articles:


All Articles