可以使用pydoc生成联机帮助页吗?

时间:2015-10-21 09:53:00

标签: python documentation-generation man pydoc

我有一组python脚本,我想为其创建联机帮助页。它们记录在文档字符串中,所以我可以通过这种方式获取文档,但我也希望有联机帮助页。

有没有办法使用pydoc为联机帮助页生成* roff源?

编辑:类似perl的pod2man for python。

1 个答案:

答案 0 :(得分:0)

pydoc不会生成联机帮助页,只是以手册页的形式显示文档:

  

...的风格类似于Unix man命令显示的手册页......

您可以按以下方式保存:

pydoc sys >sys-docs.txt

或使用终端"颜色" (使用less渲染它们):

PAGER="cat>sys-docs.txt" pydoc sys