有没有办法阻止在Sphinx文档中显示评估的默认值?

时间:2013-01-01 21:40:18

标签: python documentation-generation python-sphinx

  

可能重复:
  Override function declaration in autodoc for sphinx

如果我有

形式的功能
def some_function(..., some_opt=some_opt_default)

,其中

some_opt_default = "some really long ugly thing that certainly doesn't belong in the section header for the documentation of `some_function`, especially since could just link to the documentation for this"

然后使用Sphinx

.. autofunction:: some_function

产生类似

的东西
  

some_function(...,“一些非常长的丑陋的东西,当然不属于文档的部分标题中   'some_function',特别是因为可以链接到这个“)

的文档

有没有办法抑制some_opt_default的评估,以便Sphinx只生成

  

def some_function(...,some_opt = some_opt_default)

理想情况下,some_opt_default可以链接到相应的部分吗?

0 个答案:

没有答案