如何省略Sphinx上的变量值？

Question

我有一些模块级变量，它们具有长且无趣的值，我想从自动生成的文档中排除这些值。有没有办法做到这一点？

例如，在我的Python源代码中，我有类似

的内容

#:This is a variable with a log value.
long_variable = "Some really long value that is not really of interest and just kind of gets in the way of reading and understanding what's going on."

在我的狮身人面像来源中我有

.. automodule:: the_module
   :members:

我希望文档省略变量值。

如何省略Sphinx上的变量值？有没有办法在Python源代码中为特定变量执行此操作;我可以在Sphinx源中为整个模块或单个变量吗？

Answer 1

我能想到的两个解决方案：

• 使用猴子补丁截断此答案中建议的长变量值：https://stackoverflow.com/a/25163963/407651。

• 使用autodata选项使用{{1}}记录模块级变量。

Answer 2

要隐藏变量的内容，请使用元信息列表字段 https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#info-field-lists。

可以在此处找到示例https://stackoverflow.com/a/67999830/487993