NAME

Perinci::Sub::To::Text - Generate text documentation from Rinci function metadata

VERSION

This document describes version 0.860 of Perinci::Sub::To::Text (from Perl distribution Perinci-To-Doc), released on 2017-08-12.

SYNOPSIS

 use Perinci::Sub::To::Text;

 my $doc = Perinci::Sub::To::Text->new(meta => {...});
 say $doc->gen_doc;

You can also try the peri-doc script with the --format text option:

 % peri-doc --format text /Some/Module/somefunc

To generate a usage-like help message for a function, you can try peri-func-usage which is included in the Perinci::CmdLine::Classic distribution.

 % peri-func-usage http://example.com/api/somefunc

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Perinci-To-Doc.

SOURCE

Source repository is at https://github.com/perlancar/perl-Perinci-To-Doc.

BUGS

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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2017, 2016, 2015, 2014, 2013 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.