I have Perl module with code along the line of:
our %stuff = (
foo => 'This is for alpha blah blah ...',
bar => 'This is for beta blah blah ...',
baz => 'This is for gamma blah blah ...',
...
);
I want document this to users. Is there an easy way to produce something like this from the code, instead of typing (and syncing) them manually:
=head3 %stuff
=over 4
=item * foo => 'This is for alpha blah blah ...'
=item * bar => 'This is for beta blah blah ...'
=item * baz => 'This is for gamma blah blah ...'
=back
I suspect this is the domain of PodWeaver and stuff, anyone care to give a guide on how to use this and possibly incorporate this into Dist::Zilla building process? Thanks.
Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
Read Where should I post X? if you're not absolutely sure you're posting in the right place.
Please read these before you post! —
Posts may use any of the Perl Monks Approved HTML tags:
- a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
| |
For: |
|
Use: |
| & | | & |
| < | | < |
| > | | > |
| [ | | [ |
| ] | | ] |
Link using PerlMonks shortcuts! What shortcuts can I use for linking?
See Writeup Formatting Tips and other pages linked from there for more info.