App::Pinto::Command::doc - generate html docs from the dists in a stack
version 0.004
pinto --root=REPOSITORY_ROOT doc --out=HTML_ROOT [OPTIONS]
This command creates html documents from the distributions on a stack. It uses Pod::ProjectDocs to do the HTML generation. The command's options are a combination of the pinto list and pod2projectdocs commands.
The Pinto API is not yet stable so it's entirely possible that changes to Pinto will break this module.
This module doesn't work with remote Pinto repositories.
HTML_ROOT is the directory where the HTML docs will be generated. The directory will be created for you if it doesn't exist.
HTML_ROOT
The TITLE that will be used as a header to the generated HTML docs.
TITLE
The DESCRIPTION that will be used in the generated HTML docs.
DESCRIPTION
The CHARSET that will be used in the HTML meta tag. Defaults to UTF-8.
CHARSET
Don't create an index on each of the pod pages.
Generate documents each time ignoring the last modified timestamp.
The LANG that will be set as xml:lang. Default to 'en'.
LANG
Limit the listing to records where the distribution author is AUTHOR. Note this is an exact match, not a pattern match. However, it is not case sensitive.
Limit the listing to records where the distribution archive name matches PATTERN. Note that PATTERN is just a plain string, not a regular expression. The PATTERN will match if it appears anywhere in the distribution archive name.
PATTERN
Limit the listing to records where the package name matches PATTERN. Note that PATTERN is just a plain string, not a regular expression. The PATTERN will match if it appears anywhere in the package name.
Limit the listing to records for packages that are pinned.
List the contents of the stack with the given NAME. Defaults to the name of whichever stack is currently marked as the default stack. Use the stacks command to see the stacks in the repository.
Limit the listing to only local distributions.
Andy Gorman <agorman@cpan.org>
This software is copyright (c) 2013 by Andy Gorman.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Pinto::Action::Doc, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Pinto::Action::Doc
CPAN shell
perl -MCPAN -e shell install Pinto::Action::Doc
For more information on module installation, please visit the detailed CPAN module installation guide.