如何让Sphinx为纯RST中的属性生成TOC条目

Question

我有一组“纯 RST”Sphinx 文件，用于编写多类 API 文档。 这是这个项目的开始，所以你可以看到我正在使用的结构和指令。一切进展顺利，只是每个

.. class::

的侧边栏和文档目录仅包含

.. method::

成员，而不包含

.. property::

成员。您可以通过上面的

link

和每个上的“查看页面源代码”链接查看我的 RST 源和结果（包括缺少的 .. property:: 条目），包括

toctree

指令和文档结构。

为什么它不生成属性的目录条目？我可以做什么来获取每个类别的成员 TOC 条目的完整列表。请注意，他的

.. include::

成员被标记为

:noindex:

，所以我知道为什么他们没有被列出（单独的故事！）。

Answer 1

由于 Python 风格的数据类型提示的存在而导致的问题：

.. property:: Foo -> int

但是会导致目录和永久链接失败

.. property:: Foo

工作完美。正如@mzjn 在评论中指出的那样，

.. property:: Foo
   :type: Integer

以非 Python 的方式生成我一直在寻找的类型化属性，甚至更好。

奇怪的是，方法上存在类型提示，如

.. method:: DoIt() -> int

不会导致目录或永久链接错误并且渲染良好。这就是让我发疯的原因。