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:: 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 に答える