Pod::ProjectDocs - generates CPAN like project documents from pod.
#!/usr/bin/perl -w use strict; use Pod::ProjectDocs; my $pd = Pod::ProjectDocs->new( libroot => '/your/project/lib/root', outroot => '/output/directory', title => 'ProjectName', ); $pd->gen(); #or use pod2projdocs on your shell pod2projdocs -out /output/directory -lib /your/project/lib/root
This module allows you to generates CPAN like pod pages from your modules for your projects. It also creates an optional index page.
output directory for the generated documentation.
your library's (source code) root directory.
You can set single path by string, or multiple by arrayref.
my $pd = Pod::ProjectDocs->new( outroot => '/path/to/output/directory', libroot => '/path/to/lib' );
or
my $pd = Pod::ProjectDocs->new( outroot => '/path/to/output/directory', libroot => ['/path/to/lib1', '/path/to/lib2'], );
your project's name.
description for your project.
whether you want to create an index for all generated pages (0 or 1).
set this language as xml:lang (default 'en')
whether you want to generate HTML document even if source files are not updated (default is 0).
the files matches this regex won't be parsed.
Pod::ProjectDocs->new( except => qr/^specific_dir\//, ...other parameters ); Pod::ProjectDocs->new( except => [qr/^specific_dir1\//, qr/^specific_dir2\//], ...other parameters );
You can use the command line script pod2projdocs to generate your documentation without creating a custom perl script.
pod2projdocs -help
Pod::Parser
Copyright(C) 2005 by Lyo Kato
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.
To install Pod::ProjectDocs, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Pod::ProjectDocs
CPAN shell
perl -MCPAN -e shell install Pod::ProjectDocs
For more information on module installation, please visit the detailed CPAN module installation guide.