Ich dokumentiere ein Modul, das eine Reihe von opaken konstanten Sentinel-Werten darstellt, die die verschiedenen möglichen Zustände einer Zustandsmaschine darstellen.Kann ich mehrere Konstanten in einer einzigen Zeile dokumentieren?
Es gibt wirklich nichts Interessantes zu jedem einzelnen von ihnen zu sagen. Derzeit sehen meine docs wie:
[... state machine diagram ...] [... high level explanation ...]
States are represented using one of the following constants:
.. data:: IDLE
.. data:: SEND_RESPONSE
.. data:: SEND_BODY
[and so on for another 10 lines]
Die gute Sache über einen .. data:: Eintrag für jede Konstante zu machen ist, dass es bedeutet, dass später kann ich durch das Schreiben Dinge auf diese Dokumente Hyperlink zurück wie
If the connection is in the :data:`IDLE` state...
und sie im Index erscheinen und so weiter. Das Schlimme daran ist, dass jede dieser Konstanten nur für sich selbst einen großen fettgedruckten Absatz erhält, so dass die ganze Liste letztendlich wie ein ganzer Bildschirm voll der gerenderten Dokumente mit im Grunde genommen keinem Inhalt abschneidet.
Ich möchte sie irgendwie nur in einer einzigen Zeile auflisten ("Eine der folgenden Konstanten: IDLE, SEND_RESPONSE, ..."), oder die Liste sogar ganz auslassen ("Für jeden der genannten Zustände im obigen Diagramm gibt es eine entsprechende Modulebene-Konstante ... "), und dennoch funktioniert die Indizierung und Vernetzung von sphinx noch.
Vielleicht gibt es eine Möglichkeit, Sphinx zu sagen "Hey psst, Sie müssen hier nichts rendern, aber nur zur Kenntnis nehmen Sie diesen Absatz die folgenden Datenelemente"? Oder irgendwelche anderen Ideen, wie man das Durcheinander hier reduzieren kann?
