[PYTHON] So schreiben Sie eine Dokumentzeichenfolge, um ein benanntes Tupeldokument mit Sphinx zu erstellen
Ich suche einen Weg, um das Thema zu erreichen.
Was du machen willst
Ich möchte aus docstring ein Dokument für "named tuple" erstellen.
sample.py
NamedTuple = namedtuple("NamedTuple", "aaa bbb ccc")
Bei der Definition eines "benannten Tupels" wie oben Die Frage, wie man einen Docstring schreibt.
Versuch 1
Was passiert, wenn Sie "NamedTuple" so wie es ist verwenden und das Dokument mit "Sphinx" erstellen?
.. autoclass:: simplesqlite.sample.NamedTuple
:members:
:undoc-members:
Es wurde wie folgt. Mitglieder werden angezeigt, aber es gibt keine Menge an Informationen, wenn nur die Erklärungen der Mitglieder automatisch ausgegeben werden.
Versuch 2
Einige Leute hatten die gleiche Herausforderung.
Adding docstrings to namedtuples in Python? - Stack Overflow http://stackoverflow.com/questions/1606436/adding-docstrings-to-namedtuples-in-python
Es wurden mehrere Methoden beantwortet. Definieren wir eine Klasse, die "namedtuple" erbt, und versuchen, eine Dokumentzeichenfolge in die Klasse zu schreiben.
class NamedTupleWithDocstring1(namedtuple("NamedTuple", "aaa bbb ccc")):
"""
hogehoge
"""
Wenn Sie dies mit Sphinx machen
Es wäre schön, die Erklärung des Mitglieds hinzuzufügen.
Letzte
class NamedTupleWithDocstring2(namedtuple("NamedTuple", "aaa bbb ccc")):
"""
hogehoge
.. py:attribute:: aaa
Description of the ``aaa``.
.. py:attribute:: bbb
Description of the ``bbb``.
.. py:attribute:: ccc
Description of the ``ccc``.
"""
Recommended Posts