如何在 Sphinx 文档中显示类的继承成员?

2024-01-18

我想记录一些类,这些类都派生自具有一些公共属性的同一基类,并且我想重复子类中每个属性的文档,以便我可以在一个位置看到一个类的所有属性。

例如我有这样的代码:

class Base(object):

    """Base class."""

    #: First attribute
    a = int
    #: Second attribute
    b = str

class FirstChild(Base):

    """First Child of Base."""

    #: Child attribute
    c = float

class SecondChild(Base):

    """Second Child of Base."""

    pass

我首先有这个:

.. automodule:: example
   :members:
   :show-inheritance:

输出将是这样的:

class class example.Base

   Bases: "object"

   Base class.

   a
      First attribute
      alias of "int"

   b
      Second attribute
      alias of "str"

class class example.FirstChild

   Bases: "example.Base"

   First Child of Base.

   c
      Child attribute
      alias of "float"

class class example.SecondChild

   Bases: "example.Base"

   Second Child of Base.

有没有办法生成文档,使子类也具有继承的属性?

例如:

class class example.FirstChild

   Bases: "example.Base"

   First Child of Base.

   a
      First attribute
      alias of "int"

   b
      Second attribute
      alias of "str"

   c
      Child attribute
      alias of "float"

class class example.SecondChild

   Bases: "example.Base"

   Second Child of Base.

   a
      First attribute
      alias of "int"

   b
      Second attribute
      alias of "str"

您需要添加:inherited-members:选项,引用文档:

对于类和异常,在记录所有成员时将从基类继承的成员将被忽略,除非除了成员之外还提供了herited-members 标志选项。

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

如何在 Sphinx 文档中显示类的继承成员? 的相关文章

  • 在 Python 文档字符串中引用参数

    我使用 Sphinx 和自动文档功能来确保我们的项目中有良好的文档 所以我很熟悉信息字段列表 http sphinx doc org domains html info field lists我熟悉使用交叉引用 http sphinx do
  • Sphinx 和 JavaScript 文档工作流程 [关闭]

    Closed 这个问题需要多问focused help closed questions 目前不接受答案 对于我的 JavaScript 框架 我想使用 Sphinx 由于我是 Sphinx 世界的新手 我希望你们能帮助我开始使用 Sphi
  • “职称级别不一致”是什么意思?

    我在我的文档版本中收到了各种 标题级别不一致 的警告 据我所知 我有一个一致的结构 如下所示 Big Title Section Subsection 但该错误与自动生成相关 automodapi 我无法找到的文本 Classes 我怎样才
  • 如何在每个页面的侧边栏中包含目录树

    我正在 Sphinx 中生成 html 文档 如何修改文档中每个 html 页面的侧边栏 以便它们包含目录树 默认情况下 目录树似乎只显示在master doc页面 并且仅在主区域而不是侧边栏 是否有捷径可寻 我将使用 readthedoc
  • NumPy 如何将文档字符串处理为参数的 sphinx 文档?

    我想使用 sphinx 构建我们的文档 并获得与 NumPy 文档相同的参数格式 https github com numpy numpy blob master doc HOWTO DOCUMENT rst txt https githu
  • 为自定义指令的节点生成标签

    使用Sphinx TODO 指令示例 https www sphinx doc org en master development tutorials todo html我想参考一下todo嵌入在 rst 文件中的实例 例如 如果 rst
  • 带有标题的剩余图像网格?

    作为对此的扩展question https stackoverflow com questions 10219634 image grid in restructuredtext sphinx 如何使用 Sphinx 和 reStructu
  • 如何在 RST/阅读文档的代码块中添加复制按钮

    我一直在编写个人 操作方法 指南 记录并保留我的学习日记 我现在有一个几乎太长的代码块 当我自己遇到这么长的代码时 试图仅突出显示该代码块而不突出显示整个页面 或者还不够 总是令人沮丧 所以 我的问题是 对于rst 重构文本 code bl
  • 通过序言格式化 csv 表?

    尽我所能 我无法弄清楚如何更改 sphinx 的 pdf 输出中的默认表格格式 我可以编辑 tex 文件或 writer py 源代码 但这两个似乎都是不好的选择 有什么东西可以通过序言来实现这一点吗 取决于您试图通过更改表格格式来完成的任
  • Sphinx 扩展可在 Sphinx 中使用 GitHub markdown 表情符号吗?

    Problem 我一直在使用 Python Sphinx 文档 http www sphinx doc org 随着通用标志 http commonmark org 解析器 用于编写包含以 reStructuredText 和 Markdo
  • 将可点击的 SVG 图像插入 Sphinx 文档

    我有 SVG 图像文件 其中有多个节点 每个节点都与 URL 关联 如果我直接在浏览器中打开此文件 我可以单击每个节点 它将打开不同的 URL 但是 当我在 Sphinx 文档中使用这张图片时 它不起作用 图片作为一个整体呈现 所以我需要通
  • Sphinx 文档中使用全局变量标准化链接

    我正在使用 Sphinx 来记录工作项目 我想在整个文档的多个页面上使用指向下载的相同链接 例如 home rst Hi I want you to download my project download blah com downloa
  • 如何有条件地将文件包含在 Sphinx 'toctree' 中? [复制]

    这个问题在这里已经有答案了 我想仅在设置了某个标签时才将我的文件之一包含在 Sphinx TOC 中 但是明显的方法失败了 toctree maxdepth 5 index core utils oec plotting install n
  • 如何在节标题和段落之间添加额外的空格

    我希望标题和段落之间以及段落之间有更多的空间 我不希望这是一个全局设置 但我想在需要的地方和时间使用它 感谢任何建议 您可以在行首使用竖线在输出中生成空行 像这样 Heading Paragraph with text
  • 通过 :ref:? 从 ReST 文档中提取文本块

    我有一些 reStructuredText 文档 我想在在线帮助中使用其中的片段 似乎一种方法是通过引用 剪掉 标记片段 例如 my boring section Introductory prose blah blah blah my i
  • 在 Sphinx 中的引用中保留内联代码

    在 Sphinx 中 如果我有以下标题声明 somestuff this is code this is not 它呈现如下 this is code 这不是 这很好 但是 如果我使用参考 例如 Have a look at ref som
  • 如何处理 ReST 中的两个破折号

    我正在使用 Sphinx 来记录用 Python 编写的命令行实用程序 我希望能够记录命令行选项 例如 region像这样 region
  • 用于将一个文档包含到另一个文档中的 sphinx 指令是什么?

    在我的文档中我有一个examples我可以说的目录 literalinclude examples 1 basic usage py language python linenos 效果很好 因为它们是代码 并且它们的格式正确为代码 但是
  • 如何收集 Sphinx 中的所有外部链接?

    我必须在手册中放入一些外部链接 并且希望在 部分甚至整本书的末尾 不重要 列出所有链接 而无需手动重复它们 我怎样才能做到这一点 这是带有参考书目的文档的摘录 呈现的版本是here http packages python org pyte
  • 使用 Sphinx 时,如何记录没有文档字符串的成员?

    我正在为我发布的包编写文档 我发现您的文档越全面 人们就越容易找到您的包来使用 废话 实际上 我在充满爱心地编写代码的所有功能和细节方面获得了很多乐趣 然而 我对如何为类级变量编写与 Sphinx 兼容的文档感到完全困惑 特别是 我有一些e

随机推荐

  • Wix - 如何使用一个可执行文件安装多个 Windows 服务?

    我正在尝试使用相同的可执行文件安装多个 Windows 服务 但 WiX 不喜欢两个文件标记中的相同名称属性 我尝试更改两个文件标签的名称 它可以工作 但我希望我不必为此目的安装两个相同的可执行文件 有一个更好的方法吗 到目前为止 这是我的
  • Launch4j 中的异常

    我的 build xml 中有以下说明 但出现以下异常 launch4j net sf launch4j ExecException 执行失败 1 C Program 文件 Launch4j bin windres exe preproce
  • C#:专用模板方法 - 错误:类型“...”已定义具有相同参数类型的名为“...”的成员

    我对 C 很陌生 目前正在使用 EntityFramework 开发应用程序 我想扩展数据库上下文类的功能 以便我可以调用方法 getPool 以便它分发该类的相应 DbSet 成员 我需要将它实现为模板 因为稍后将从其他模板调用它 这些模
  • GHC 外部 hs_init/hs_add_root 崩溃

    不必要的我就不重复了 简单总结一下 继Adder本教程中的示例 http blogs msdn com b satnam singh archive 2011 04 19 creating a windows dll from a hask
  • Spring Boot 1.4.0:REST 控制器未将原因设置为 HTTP 响应

    我有 2 个使用 Spring Tool Suite Spring Starter Project 创建的项目 第一个项目 Spring Boot 1 3 7 发布 Web 第二个项目 Spring Boot 1 4 0 发布 Web 我更
  • 为什么 ConcurrentBag 不实现 ICollection

    我有一个方法需要IList
  • 使用 TinyXML 解析 XML 元素

    更新 仍然无法工作 我已经更新了代码部分以反映我当前拥有的内容 对于使用过 TinyXML 的人来说 这应该是一个相当简单的问题 我正在尝试使用 TinyXML 来解析 XML 文档并提取一些值 我昨天弄清楚了如何在库中添加 并且我已经成功
  • Ruby 1.9 中的自动加载是线程安全的吗?

    在我看来 自从 Ruby 社区开始对自动加载感到有点害怕这个著名的线程 http www ruby forum com topic 172385 出于线程安全原因不鼓励使用它 有谁知道这在 Ruby 1 9 1 或 1 9 2 中是否不再是
  • 使用 python 进行非线性回归 - 有什么简单的方法可以更好地拟合这些数据?

    我有一些想要拟合的数据 这样我就可以对给定特定温度的物理参数的值进行一些估计 我使用 numpy polyfit 作为二次模型 但拟合效果并不像我希望的那么好 而且我在回归方面没有太多经验 我已经包含了散点图和 numpy 提供的模型 S
  • MSVC++7.1 中的 ifstream.read() 与 ifstream.readsome()

    我只是采用了在 Linux 下开发的文件阅读器的一些旧代码 并尝试在使用 MSVC 7 1 编译的 Windows 项目中使用相同的代码 代码编译没有任何问题 但根据 Windows 上的文件阅读器 该文件似乎是空的 我跟踪问题到 ifst
  • Azure 流量管理器 SSL 设置(非经典)

    我有一个 Azure API 应用服务 我想为其配置 优先 流量管理 这是新的流量管理器 不是经典的 我已将该服务部署到两个独立的 Azure 区域 并配置了流量管理器实例以执行到两个服务实例的优先级路由 这些服务具有以下自定义域配置 fo
  • 在asp.net应用程序上显示sql数据库中存储的UTC时间的本地时间

    我已经将时间以 utc 格式保存在 SQL 数据库中 我在网格视图上显示这些时间 但它们仍然是 UTC 格式 我想将它们转换为客户端浏览器的本地时间 问题是 虽然我可以获得仅适用于当前日期 时间的时区偏移量 如果未来的某些日期最终发生在夏令
  • 如何在 Angular 2 最终版本中编写 HTTP 模拟单元测试?

    我已从 RC4 迁移到最终版本 2 1 0 并且正在重构我的单元测试以符合 2 1 0 语法 除了 HTTP 模拟之外 这很容易 我找不到任何关于如何在 2 1 0 中模拟 HTTP 请求的示例 这是一个 RC4 HTTP 单元测试 我将如
  • 使用 msbuild 从网站部署中排除文件

    我有一个使用 msbuild 部署的网站项目 在项目中 有一些构建所需的文件和文件夹 例如 web config 部分替换文件 但我不想将其部署到目标站点 我能想到的最好的办法是删除这些文件的构建后目标 但我想知道是否有办法让这些文件不复制
  • 由于占用率低而导致 GPU 利用率不足是什么意思?

    我正在使用 NUMBA 和 cupy 来执行 GPU 编码 现在我已将代码从 V100 NVIDIA 卡切换到 A100 但是随后我收到以下警告 NumbaPerformanceWarning 网格大小 27 NumbaPerformanc
  • VSCode Flutter Dart 慢的建议

    我使用 Visual Studio Code 进行 flutter 编程 并且没有使用很多扩展 我喜欢代码补全 但通常太慢 显示所有建议大约需要 1 2 秒 这个问题有什么解决办法吗 这是我已安装的扩展的列表 我被告知要添加此配置 dart
  • 什么是 WCF 服务参考 .datasource 文件?

    Visual Studio 中 创建服务引用 自动生成的 datasource 文件是什么 文件中的注释是这样的 该文件是自动生成的 由 Visual Studio Net 提供 这是 用于存储通用对象数据源配置信息 重命名文件扩展名或编辑
  • FormData 键作为数组

    我正在尝试使用 FormData html5 api 设置多个文件上传 问题是我无法删除 FormData 键上的数组索引 前任 if editor frmData editor frmData append upload files 0
  • IntelliJ Idea Android 项目包括 apk 中不受监管的文件

    我有一个复杂的应用程序结构 主项目有 android 库 它们有自己的 android 库和 jar 主要工程 Libs Android Lib project A Jars Android Lib项目B Jars 为了澄清起见 我有一个
  • 如何在 Sphinx 文档中显示类的继承成员?

    我想记录一些类 这些类都派生自具有一些公共属性的同一基类 并且我想重复子类中每个属性的文档 以便我可以在一个位置看到一个类的所有属性 例如我有这样的代码 class Base object Base class First attribut