.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Pod::ProjectDocs 3pm"
.TH Pod::ProjectDocs 3pm "2021-02-21" "perl v5.32.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Pod::ProjectDocs \- generates CPAN like project documents from pod.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    #!/usr/bin/perl
\&
\&    use strict;
\&    use warnings;
\&
\&    use Pod::ProjectDocs;
\&
\&    my $pd = Pod::ProjectDocs\->new(
\&        libroot => \*(Aq/your/project/lib/root\*(Aq,
\&        outroot => \*(Aq/output/directory\*(Aq,
\&        title   => \*(AqProjectName\*(Aq,
\&    );
\&    $pd\->gen();
\&
\&    # or use pod2projdocs on your shell
\&    pod2projdocs \-out /output/directory \-lib /your/project/lib/root
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module allows you to generates \s-1CPAN\s0 like pod pages from your modules
for your projects. It also creates an optional index page.
.SH "OPTIONS"
.IX Header "OPTIONS"
.ie n .IP """outroot""" 4
.el .IP "\f(CWoutroot\fR" 4
.IX Item "outroot"
output directory for the generated documentation.
.ie n .IP """libroot""" 4
.el .IP "\f(CWlibroot\fR" 4
.IX Item "libroot"
your library's (source code) root directory.
.Sp
You can set single path by string, or multiple by arrayref.
.Sp
.Vb 4
\&    my $pd = Pod::ProjectDocs\->new(
\&        outroot => \*(Aq/path/to/output/directory\*(Aq,
\&        libroot => \*(Aq/path/to/lib\*(Aq
\&    );
.Ve
.Sp
or
.Sp
.Vb 4
\&    my $pd = Pod::ProjectDocs\->new(
\&        outroot => \*(Aq/path/to/output/directory\*(Aq,
\&        libroot => [\*(Aq/path/to/lib1\*(Aq, \*(Aq/path/to/lib2\*(Aq],
\&    );
.Ve
.ie n .IP """title""" 4
.el .IP "\f(CWtitle\fR" 4
.IX Item "title"
your project's name.
.ie n .IP """desc""" 4
.el .IP "\f(CWdesc\fR" 4
.IX Item "desc"
description for your project.
.ie n .IP """index""" 4
.el .IP "\f(CWindex\fR" 4
.IX Item "index"
whether you want to create an index for all generated pages (0 or 1).
.ie n .IP """lang""" 4
.el .IP "\f(CWlang\fR" 4
.IX Item "lang"
set this language as xml:lang (default 'en')
.ie n .IP """forcegen""" 4
.el .IP "\f(CWforcegen\fR" 4
.IX Item "forcegen"
whether you want to generate \s-1HTML\s0 document even if source files are not updated (default is 0).
.ie n .IP """nosourcecode""" 4
.el .IP "\f(CWnosourcecode\fR" 4
.IX Item "nosourcecode"
whether to suppress inclusion of the original source code in the generated output (default is 0).
.ie n .IP """except""" 4
.el .IP "\f(CWexcept\fR" 4
.IX Item "except"
the files matches this regex won't be parsed.
.Sp
.Vb 4
\&  Pod::ProjectDocs\->new(
\&    except => qr/^specific_dir\e//,
\&    ...other parameters
\&  );
\&
\&  Pod::ProjectDocs\->new(
\&    except => [qr/^specific_dir1\e//, qr/^specific_dir2\e//],
\&    ...other parameters
\&  );
.Ve
.SH "pod2projdocs"
.IX Header "pod2projdocs"
You can use the command line script pod2projdocs to generate your documentation
without creating a custom perl script.
.PP
.Vb 1
\&    pod2projdocs \-help
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Pod::Simple::XHTML
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "Lyo Kato <lyo.kato@gmail.com>" 4
.IX Item "Lyo Kato <lyo.kato@gmail.com>"
.PD 0
.IP "Martin Gruner <https://github.com/mgruner> (current maintainer)" 4
.IX Item "Martin Gruner <https://github.com/mgruner> (current maintainer)"
.PD
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
.IP "© 2005 by Lyo Kato" 4
.IX Item "© 2005 by Lyo Kato"
.PD 0
.IP "© 2018 by Martin Gruner" 4
.IX Item "© 2018 by Martin Gruner"
.PD
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.5 or,
at your option, any later version of Perl 5 you may have available.