in reply to Re^2: Perl Module Documentation
in thread Perl Module Documentation
The options I mentioned allow you to selectively produce a plain text file (formatted with spaces and newlines) of the relevant doc (and pod, TBOMK) using a CLI command like this (under Win):
F:\pl_docs>perldoc -d nextpod.out -T -o f next Perldoc (Pod::Perldoc::ToText) output saved to nextpod.out
The -d argument is the outfile name; -T says "don't page" and -o can specify a format, but is not something I've played with seriously. (Note, NO hyphen before the "f" preceding the function name. I have no clue why it works that way.)
From there, wrap the output in minimal html,
html <head> <title> <!-- (module or function title) --> </title> </head> <body> <pre> <!-- (content of your output from above, verbatim) --> </pre> </body> </html>
However, automating the above in a script may be more work than I've considered. Making the .html 'semantic' would certainly be more work.
So, in all honesty (/me flushes with pseudo-embarassment and pride at his self-congratulatory caveat), RichardK's pointer to Pod::Webserver now seems likely to be a far better way to do the job, unless it's bug-ridden. And in further honesty, you're right about needing to be obvious -- I just thought it would be to a Monk as experienced and wise (if sometimes, a tad sharp with others) as you. But since the post will stand for others, apologies, also, for failing to follow that guidance.
But, afterthought, would you please stick <c>readmore<c>s in there somewhere?
|
|---|
| Replies are listed 'Best First'. | |
|---|---|
|
Re^4: Perl Module Documentation
by BrowserUk (Patriarch) on Dec 20, 2011 at 21:03 UTC |