Pod::Pandoc::Modules - set of parsed documentation of Perl modules
use Pod::Simple::Pandoc; my $modules = Pod::Simple::Pandoc->new->parse_modules('lib'); $modules->serialize( { target => 'doc' }, '--template' => '...' ] ); # TODO
Module to serialize Pod from a set of parsed Perl or Pod files. Can be configured via templates, document rewriting etc. and used with many output formats (html, markdown, and rst to be embedded in static site generators such as Jekyll).
See Pod::Simple::Pandoc for how to create instances of this module.
Add a module given as Pandoc::Document unless a module of same $name already exists. As an exception a parsed .pod file will override existing entries. The document title is set to the module name if missing.
$name
Serialize a set of modules into a given directory.
This method is experimental and may change!
Output directory.
Output file extension. Set to the value of format by default.
format
Index filename (with or without extension). Set to index by default. Use a false value to disable index generation.
index
Don't create subdirectories and use wiki links for references between files. instead.
Generate target files even if source files have not been updated.
Don't emit warnings and status information.
Create and return an index document as Pandoc::Document.
This module is part of Pod::Pandoc.
To install Pod::Pandoc, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Pod::Pandoc
CPAN shell
perl -MCPAN -e shell install Pod::Pandoc
For more information on module installation, please visit the detailed CPAN module installation guide.