Как создать табличный вывод в reStructuredText без использования формата таблицы RST? - PullRequest
Новая
       81

Как создать табличный вывод в reStructuredText без использования формата таблицы RST?

5 голосов
/ 19 октября 2011

Я пытаюсь перенести наши документы 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?

1 Ответ

3 голосов
/ 09 декабря 2011

Не думаю, что вам нужна специальная директива. Вы пытались использовать стандартный реструктурированный текст Список таблиц ?

Это выглядит примерно так (со связанной страницы): 

.. 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% пути.

...