相关疑难解决方法(0)

我目前正在记录整个模块autodoc.但是,我在模块级别定义了几个包含长列表或dicts的变量.它们与值一起包含在文档中,并且值未格式化,因此看起来像10行混乱.我想要的是包含那些变量的docstring,但是要省略值或至少很好地格式化.

我试图从automodule指令中排除变量并添加它:

.. automodule:: foo.bar
   :members:
   :exclude-members: longstuff

   .. py:data:: longstuff

这导致只包含变量名,而文档字符串和值longstuff都没有出现在文档中.

如何保持文档字符串并同时删除值(或者格式良好)？提前致谢.

我正在使用Sphinx的autodoc功能来记录我的API.

例:

DEFAULT_OPTION = 'default'
def do_something(msg, option=DEFAULT_OPTION):
    print msg

生成的文档现在显示以下签名:

do_something(msg, option='default')

如何告诉Sphinx保留常量值的名称,即

do_something(msg, option=DEFAULT_OPTION)

？

有没有我忽略的选择？如果可能的话,我不想再用手写所有的签名.