1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
# NAME
Pod::ProjectDocs - generates CPAN like project documents from pod.
# SYNOPSIS
#!/usr/bin/perl
use strict;
use warnings;
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
# DESCRIPTION
This module allows you to generates CPAN like pod pages from your modules
for your projects. It also creates an optional index page.
# OPTIONS
- `outroot`
output directory for the generated documentation.
- `libroot`
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'],
);
- `title`
your project's name.
- `desc`
description for your project.
- `index`
whether you want to create an index for all generated pages (0 or 1).
- `lang`
set this language as xml:lang (default 'en')
- `forcegen`
whether you want to generate HTML document even if source files are not updated (default is 0).
- `nosourcecode`
whether to suppress inclusion of the original source code in the generated output (default is 0).
- `except`
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
);
# pod2projdocs
You can use the command line script [pod2projdocs](https://metacpan.org/pod/pod2projdocs) to generate your documentation
without creating a custom perl script.
pod2projdocs -help
# SEE ALSO
[Pod::Simple::XHTML](https://metacpan.org/pod/Pod%3A%3ASimple%3A%3AXHTML)
# AUTHORS
- Lyo Kato <lyo.kato@gmail.com>
- [Martin Gruner](https://github.com/mgruner) (current maintainer)
# COPYRIGHT AND LICENSE
- © 2005 by Lyo Kato
- © 2018 by Martin Gruner
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.
|
