perl – 将给定命名空间中的所有POD转换为一个大的HTML页面

前端之家收集整理的这篇文章主要介绍了perl – 将给定命名空间中的所有POD转换为一个大的HTML页面前端之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。
有几次需要咨询文档.一些(较大的)系统由许多包和容器组成,并且并不总是清楚所描述的给定方法在哪里,例如,它在Pgk :: Req或Pkg :: Utils等…
搜索正确的POD以获取给定方法的描述确实非常耗时且非常无聊. (

因此,寻找一些如何从给定命名空间转换所有POD的方法,例如一些:: Pkg ::成为一个大的HTML页面.

我不需要任何花哨的交叉链接或者这样 – 只需要一个大格式的html页面,我可以快速找到所需方法的描述.我不关心页面大小 – 只想获得一个易于阅读的页面.

我尝试在Metacpan中浏览许多类似POD的模块 – 但是没有找到可以执行上述操作的模块.简而言之,像:

make_bigpod CHI::* >one_big.html
# and will get ALL docs for CHI.pm and CHI/*.{pm,pod} into one big page

有什么建议吗?

解决方法

perldoc页面的维护者是Jon Allen.他有一个Perldoc Server,您可以使用它来创建像perldoc站点这样的网页,但使用您的代码和pod.它包括搜索区域以及语法突出显示和索引.

http://search.cpan.org/~jonallen/Perldoc-Server-0.10/lib/Perldoc/Server.pm

如果你真的想要,你可以将生成的html合并到一个文档中……

另一个选项(TIMTOWTDI)是编写一个简短的脚本来迭代你的.pm文件,收集包名和pod部分(使用perldoc解析器http://search.cpan.org/dist/Pod-Perldoc/),然后从结果中滚动你自己的自定义html.

猜你在找的Perl相关文章