当前位置: 首页 > 面试题库 >

如何在Sphinx上忽略变量的值?

姬锐
2023-03-14
问题内容

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

例如,在我的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源代码中为整个模块还是为单个变量执行此操作?


问题答案:

解决方案:

  • 文件使用模块级变量autodataannotation选项。


 类似资料:
  • 下面是roles/role1/tasks/main.yml: 我的库存: 最后是host_vars/localhost.yml: 使用运行playbook时出现以下错误

  • 问题内容: 我正在尝试创建对象Iset的实例。当人创建对象时,他们必须给出一个整数,该整数将是一个布尔数组的大小,该布尔数组将存储一组整数,例如1将是Iset [1] = true等。但是我一直使索引超出范围错误。程序的其余部分显然会忽略我在构造函数中设置的值,那么如何确保在我的所有方法中都使用构造函数中使用的值? 代码的第一部分: 问题答案: 让我们看看您的代码: 在构造函数中,您已经看到创建了

  • 问题内容: 我以为hibernate只考虑使用注释的类变量。但是今天奇怪的是,当我添加一个变量(该变量未映射到任何列,只是我在类中需要的一个变量)时,它试图将该变量作为列名包含在select语句中并引发错误- “字段列表”中的未知列“ team1_.agencyName” 我的课 - 仅供参考…我在另一个类中使用上述类并进行多对多映射 为什么会这样? 问题答案: JPA将使用该类的 所有 属性,除

  • 问题内容: 我正在编写的Python程序将从文件顶部读取一定数量的行,并且该程序需要保留此标头以备将来使用。目前,我正在做类似以下的事情: Pylint抱怨我没有使用该变量。什么是更pythonic的方式做到这一点? 编辑:该程序的目的是将原始文件智能地拆分为较小的文件,每个文件都包含原始标头和数据的子集。因此,在读取文件的其余部分之前,我只需要读取并保留标题。 问题答案: f = open(‘f

  • 问题内容: 我有通过virtualbox在Windows上运行的boot2docker 1.4.1。我支持MITM https证书的代理。我通过在中添加以下行来配置代理: 然而,当我跑我得到 请帮助我找出忽略证书错误的正确方法。谢谢! 问题答案: 编辑 看起来新的docker仅适用于Windows 10的某些版本 。如果您仍然停留在Windows 7上,我已经更新了以下内容,以反映安装最新版本的d

  • 问题内容: 我正在尝试为api 编写Web服务。因此,我编写了一个MyLogRecord类,该类继承自LogRecord。我用JAX- B注释对此类进行了注释,包括,因此它将忽略未注释的字段和属性。当我启动tomcat时,出现错误,并且其他类没有默认的构造函数,但是没有带注释的方法对Level类或任何其他类进行任何引用。这些由父类引用。 我的子类具有需要定义的所有内容。如何使JAX-B完全忽略父类