Sphinx Direktiven für eigenes Protokoll

[jbs]

Hallo,

ich möchte gerne mit Sphinx ein Protokoll dokumentieren. Das Protokoll besteht aus JSON-Nachrichten.

Code: Alles auswählen

message = {"action": "a", "argument_1": 42}

Nun möchte ich in Sphinx in etwa sowas schreiben:

Code: Alles auswählen

Messages
========

.. action:: a

.. option:: argument_1

    Beschreibung von argument_1

Also im Prinzip analog zu direktiven wie ``class`` oder ``describe``, wobei mir bei letzterem die Verlinkung fehlt. Muss ich da eigene Direktiven schreiben, oder gibt es da vorgefertigte?

[jbs]

Ich habs jetzt mit ``attribute`` und ``param`` gelöst.

[lunar]

Du kannst auch mit ".add_object_type()" eigene Direktiven hinzufügen. Dazu einfach in der "conf.py":

Code: Alles auswählen

def setup(app):
    app.add_object_type('action', 'act', 'pair: %s, action')

Und dann in der Dokumentation:

Code: Alles auswählen

.. action:: foobar

   There and back again…

[jbs]

Dankeschön