如何在不使用RST表格格式的情況下在reStructuredText中生成表格輸出？

Question

我正在嘗試將我們的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..." 

我怎樣才能在新結構化做到這一點的custom directives任何好的例子嗎？

Answer 1

我不認爲你需要一個自定義指令。你有沒有嘗試過使用標準的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％的方式。