peri-doc - Display text/POD documentation of Riap function or package
This document describes version 0.880 of peri-doc (from Perl distribution Perinci-To-Doc), released on 2022-10-15.
% peri-doc /Some/Module/
% peri-doc --format=text https://example.com/api/some_func
% peri-doc --help
This script will generate text/POD documentation for a Riap function or package.
Please visit the project's homepage at https://metacpan.org/release/Perinci-To-Doc.
Source repository is at https://github.com/perlancar/perl-Perinci-To-Doc.
gen-pod-for-pericmd-script (from App::PericmdUtils)
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, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.
This software is copyright (c) 2022, 2021, 2020, 2019, 2018, 2017, 2016, 2015, 2014, 2013 by perlancar <email@example.com>.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
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.
To install Perinci::To::Doc, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell
For more information on module installation, please visit the detailed CPAN module installation guide.