三引号字符串文字被sphinx认为是不合需要的文档字符串

时间:2014-06-14 07:27:20

标签: python python-sphinx docstring

在我的一个__init__.py文件中:

description="""
This is a package for blablahblah.

It contains blahblah.
"""

字符串变量仅用于在其他模块中使用,我不希望sphinx识别它并将其作为文档提取出来。反正有吗?

1 个答案:

答案 0 :(得分:0)

原来这是由一个愚蠢的错误引起的:

一行“隐藏”代码行将description添加到__doc__变量。

相关问题