如何使用带Sphinx的automodule删除静态类变量？

Question

我目前正在使用Sphinx（第一次使用它）为我的模块构建文档，我有一些类，它们有一些用默认值初始化的类变量

例如：

class ConfigSettings(object):
    """Class that manages a config file
    """    
    #: Contains the path to the config file (root dir of module)
    path = Path(util.getAbsCurrentPath('configfile.ini'))

在构建文档时，会对变量进行求值，并打印我不想要的文件的完整路径（出于安全原因）。 有没有一种方法可以不显示变量值，而只显示使用Sphinx的注释

我尝试了.. autoclass:和.. autodata:的各种组合，但到目前为止没有一种有效

这是我当前在生成文件中的内容：

Config module
----------------------------

.. automodule:: lib.config
   :members:
   :undoc-members:
   :show-inheritance:

Answer 1

您可以通过在导入时不计算路径来解决此问题。我认为最好的方法是使用classproperty

例如：

class ConfigSettings(object):
    @classproperty
    def path(cls):
        return Path(util.getAbsCurrentPath('configfile.ini'))