The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Statocles::App::Perldoc - Render documentation for Perl modules

VERSION

version 0.098

DESCRIPTION

This application generates HTML from the POD in the requested modules.

ATTRIBUTES

inc

The directories to search for modules. Defaults to @INC.

modules

The root modules to find. Required. All child modules will be included. Any module that does not start with one of these strings will not be included.

index_module

The module to use for the index page. Required.

weave

If true, run the POD through Pod::Weaver before converting to HTML

weave_config

The path to the Pod::Weaver configuration file

template_dir

The directory (inside the theme directory) to use for this app's templates. Defaults to blog.

METHODS

pages

my @pages = $app->pages;

Render the requested modules as HTML. Returns an array of Statocles::Page objects.

AUTHOR

Doug Bell <preaction@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2016 by Doug Bell.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.