如何防止Sphinx显示列表的所有内容

时间:2018-10-08 11:41:45

标签: python documentation python-sphinx

我有一个用Sphinx记录的Python模块。该模块公开了很长的字符串列表。我想用文档字符串来记录此列表,但我不希望文档显示列表的所有内容,因为它会使文档混乱。

我有类似的东西:

MY_LIST = ["foo"] * 100
"""This is the docstring for my awesome list."""

如何防止Sphinx在生成的文档中显示整个长列表?

0 个答案:

没有答案