6

我正在尝试将我们的 API 文档及其专有文档生成器架构迁移到 reStructuredText。最困难的部分是，我们有一个 API 详细信息的表格表示，直接用 HTML 编码，例如：

--------+------------+--------+--------------------------------+
Param   |  Required  |  Type  |  Description
----------------------------------------------------------------
id      |     Yes    | int    | This is the ID of the record...
content |     No     | string | Optional string contents...

（即当前编码为<tr><td class='param'>id</td><td class='required'>Yes</td>...）

我想在 RST 中执行此操作，但要在语义上执行，而不仅仅是使用 RST 表格式。但是我找不到任何自定义指令的好例子来按我想要的方式处理这个问题，就像

:.. parameter-table:: My Parameter Table
    .. item::
       :param: "id"
       :required: true
       :type: "int"
       :desc: "This is the ID of the record..."

我怎样才能在 reStructuredText 中做到这一点？

4

1 回答 1

4

我认为您不需要自定义指令。您是否尝试过使用标准的 restructuredText List Table？

它看起来像这样（来自链接页面）：

.. list-table:: Frozen Delights!
   :widths: 15 10 30
   :header-rows: 1

   * - Treat
     - Quantity
     - Description
   * - Albatross
     - 2.99
     - On a stick!
   * - Crunchy Frog
     - 1.49
     - If we took the bones out, it wouldn't be
       crunchy, now would it?
   * - Gannet Ripple
     - 1.99
     - On a stick!

表头位于第一个外部列表项中（至少在此示例中）。即使这不是你想要的，我认为这会让你至少达到 90% 的目标。

于 2011-12-09T19:28:06.780 回答