Pod::ProjectDocs - generates CPAN like pod pages
#!/usr/bin/perl -w use strict; use Pod::ProjectDocs; my $pd = Pod::ProjectDocs->new( outroot => '/output/directory', libroot => '/your/project/lib/root', title => 'ProjectName', ); $pd->gen(); #or use pod2projdocs on your shell pod2projdocs -out /output/directory -lib /your/project/lib/root
See the generated pages via HTTP with your browser. Your documents of your modules are displayed like CPAN website.
directory where you want to put the generated docs into.
your library's 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' );
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.
This is used in meta tag. default 'UTF-8'
whether you want to create index on each pod pages or not. set 1 or 0.
what language is set for xml:lang
whether you want to generate HTML document even if source files are not updated. default is 0.
if you set this parameter as regex, the file matches this regex won't be checked.
Pod::ProjectDocs->new( except => qr/^specific_dir\//, ...other parameters ); Pod::ProjectDocs->new( except => [qr/^specific_dir1\//, qr/^specific_dir2\//], ...other parameters );
You need not to write script with this module, I put the script named 'pod2projdocs' in this package. At first, please execute follows.
Lyo Kato <email@example.com>
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.