Lyo Kato > Pod-ProjectDocs > Pod::ProjectDocs

Download:
Pod-ProjectDocs-0.40.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  12
Open  2
View/Report Bugs
Module Version: 0.40   Source  

NAME ^

Pod::ProjectDocs - generates CPAN like pod pages

SYNOPSIS ^

    #!/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

DESCRIPTION ^

This module allows you to generates CPAN like pod pages from your modules (not only perl but also javascript including pod) for your projects. Set your library modules' root directory with libroot option. And you have to set output directory's path with outroot option. And this module searches your pm and pod files from your libroot, and generates html files, and an index page lists up all your modules there.

See the generated pages via HTTP with your browser. Your documents of your modules are displayed like CPAN website.

OPTIONS ^

outroot

directory where you want to put the generated docs into.

libroot

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'
    );

or

    my $pd = Pod::ProjectDocs->new(
        outroot => '/path/to/output/directory',
        libroot => ['/path/to/lib1', '/path/to/lib2'],
    );
title

your project's name.

desc

description for your project.

charset

This is used in meta tag. default 'UTF-8'

index

whether you want to create index on each pod pages or not. set 1 or 0.

lang

what language is set for xml:lang

forcegen

whether you want to generate HTML document even if source files are not updated. default is 0.

except

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
  );

pod2projdocs ^

You need not to write script with this module, I put the script named 'pod2projdocs' in this package. At first, please execute follows.

    pod2projdocs -help

or

    pod2projdocs -?

SEE ALSO ^

Pod::Parser

AUTHOR ^

Lyo Kato <lyo.kato@gmail.com>

COPYRIGHT AND LICENSE ^

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.

syntax highlighting: