NAME

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

VERSION

This document describes version 0.879 of Perinci::Sub::To::Text (from Perl distribution Perinci-To-Doc), released on 2022-05-14.

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.

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2022, 2021, 2020, 2019, 2018, 2017, 2016, 2015, 2014, 2013 by perlancar <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.

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.