5

API belgelerimizi ve onların özel dokümantasyon jeneratör şemasını reStructuredText'e taşımaya çalışıyorum. (Bu anda <tr><td class='param'>id</td><td class='required'>Yes</td>... olarak kodlanmıştır yani)RST tablo biçimini kullanmadan reStructuredText'te tablo çıkışı nasıl oluşturulur?

yapmak istediğim

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

: en zor zaman verir parçası var ya HTML doğrudan kodlu API ayrıntıları tablo gösterimini, a la sahip olduğu Bu RST'de sadece RST tablo formatı kullanmak yerine semantik olarak yapın. Ama bu ben reStructuredText içinde bunu gerçekleştirmek nasıl

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

gibi bir şey olurdu ben istediğim gibi işlemek için custom directives herhangi iyi örneklerini bulamıyorum?

cevap

3

Özel bir yönergeye ihtiyacınız olduğunu düşünmüyorum. Standart bir yeniden yapılandırılmışText List Table kullanmayı denediniz mi?

O (bağlantılı sayfasından) şuna benzer:

.. 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! 

tablo başlıkları (en azından bu örnekte) birinci dış liste öğesinin içindedir. Bu tam olarak istediğin gibi olmasa bile, bence bu yolun en az% 90'ını alacaksın.

+0

Bunu beğendim. Sadece% 90 katılıyorum - alanların sadece konumsal değil, daha açık "alanlar" olsaydı tercih ederdim, fakat bu, özel bir direktifin karmaşıklığından daha iyi olması açısından yeterince basit ve temiz. Teşekkürler! – mrisher

İlgili konular