我可以在一行中记录多个常量吗？

Question

我正在记录一个模块，该模块公开了一组不透明的常量sentinel值，表示状态机的不同可能状态。

对于他们中的每一个人来说，没有任何有趣的东西可以孤立地说。目前我的文档看起来像：

[... state machine diagram ...] [... high level explanation ...]
States are represented using one of the following constants:

.. data:: IDLE
.. data:: SEND_RESPONSE
.. data:: SEND_BODY
[and so on for another 10 lines]

为每个常量创建.. data::条目的好处是，这意味着稍后我可以通过编写

之类的内容来超链接回这些文档

If the connection is in the :data:`IDLE` state...

它们出现在索引中，依此类推。坏的是这些常量中的每一个都只为自己获得一个大胆的段落，所以整个列表最终会像一整个渲染的文档一样，基本上没有内容。

我想以某种方式在一行上列出这些（“以下常量之一：IDLE，SEND_RESPONSE，...”），或者甚至将列表全部删除（ “对于上图中指定的每个状态，都有一个相应的模块级常量......”），但是sphinx的索引和交叉链接仍然有效。

也许有一些方法我可以告诉狮身人面像“嘿psst，你不需要在这里渲染任何东西，但仅仅是FYI本段记录了以下数据项”？或者关于如何减少混乱的任何其他想法？

Answer 1

想出来！你可以写：

.. data:: IDLE
          SEND_RESPONSE
          SEND_BODY
          ...

并且至少在readthedocs主题中它将呈现如下：