如何省略 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."

在我的 Sphinx 源中，我有

.. automodule:: the_module
   :members:

我希望文档省略变量值。

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

Answer 1

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

• 使用猴子补丁来截断此答案中建议的长变量值：/sf/answers/1761477441/。

• autodata使用选项记录模块级变量annotation。