时间戳

首页 > 解决方案 > Pydoc：添加部分

python - Pydoc：添加部分

问题描述

我想通过附加部分改进我的 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.

标签： pythonpydoc

解决方案

据我所知，概要仅用于手册页输出。看起来它像文档字符串或注释一样拉出了顶部，并且看起来它试图尊重延续。

在此处的源代码之外，pydoc 的临时标记语言的文档记录很差。

推荐阅读