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

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

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

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