Pydoc:添加节

Question

我想用更多的章节来改进我的python模块的文档。

例如，让我们考虑以下内容：

$ cat test.py
"""Some module

This stuff goes to the "DESCRIPTION" section.
"""

它将按如下方式呈现：

$ pydoc test
Help on module test:

NAME
    test - Some module

DESCRIPTION
    This stuff goes to the "DESCRIPTION" section.

FILE
    /tmp/tmp.XlLL4c82kb/test.py

有没有办法有一个SYNOPSYS部分，在那里我可以展示一些用法示例？

我想要的：

$ pydoc test
Help on module test:

NAME
    test - Some module

SYNOPSYS
    import test
    test.foobar()

DESCRIPTION
    This stuff goes to the "DESCRIPTION" section.

Answer 1

据我所知，摘要仅供手册页输出使用。它看起来像是拉出了文档字符串或注释的顶部，而且看起来它试图尊重continuations。

在source code here之外，pydoc的特别标记语言的文档很少。