I have my pod embedded with my code. I'm using ExtUtils::MakeMaker for deployment.

I want to instead have the pod in external files. But I want them to still deploy properly.

Where should the pod files be? If my code is lib/Book/Page.pm, should it be lib/Book/Page.pod ? I've been looking for like an hour- It's hurting my self esteem.

update. Yes indeed, if you have a file for use with Makefile.PL in lib/Uber/Cool.pm, and your documentation in lib/Uber/Cool.pod - Things work out real nice on deployment etc. ( do remember to put the files in the MANIFEST ).

I find that putting all the doc in another file is handy as far as planning (you can write out your docs with nice syntax coloring under vim, get ya real organisized)- it's nice also to look at your doc besides your code in a sepparate window. Helpful to remind you what you're supposed to be doing.

One con here- is that as a developer, looking at other people's code, I kind of like to see the documentation right besides the code. So, it could be annoying to some people to have the code and doc sepparate.

In reply to How to match up external pod files with module code by leocharre

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved HTML":


  • 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:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.