Perinci::To::Text - Generate text documentation for a package from Rinci metadata
This document describes version 0.74 of Perinci::To::Text (from Perl distribution Perinci-To-Doc), released on 2015-12-28.
use Perinci::To::POD; my $doc = Perinci::To::Text->new( name=>'Foo::Bar', meta => {...}, child_metas=>{...}); say $doc->gen_doc;
You can also try the peri-doc script with the --format text option:
--format text
% peri-doc --format text /Some/Module/
To generate a usage-like help message for a single function, you can try the peri-func-usage from the Perinci::CmdLine::Classic distribution.
Please visit the project's homepage at https://metacpan.org/release/Perinci-To-Doc.
Source repository is at https://github.com/sharyanto/perl-Perinci-To-Doc.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Perinci-To-Doc
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2015 by perlancar@cpan.org.
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 Perinci::To::Doc, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Perinci::To::Doc
CPAN shell
perl -MCPAN -e shell install Perinci::To::Doc
For more information on module installation, please visit the detailed CPAN module installation guide.