如何省略Sphinx上变量的值？ [英] How do I omit the values of variables on Sphinx?

问题描述

我有一些模块级别的变量，它们的值又长又无意义，我想从自动生成的文档中排除它们。有办法做到这一点吗？

例如，在我的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源代码中为整个模块或单个变量做到这一点吗？

推荐答案

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

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

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

这篇关于如何省略Sphinx上变量的值？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！