[PYTHON] Comment écrire une docstring pour créer un document tuple nommé avec sphinx
Cherchant un moyen d'atteindre le sujet.
Chose que tu veux faire
Je veux créer un document pour tuple nommé à partir de docstring.
sample.py
NamedTuple = namedtuple("NamedTuple", "aaa bbb ccc")
Lors de la définition d'un tuple nommé comme celui ci-dessus
La question de savoir comment écrire une docstring.
Essai 1
Que se passe-t-il si vous utilisez «NamedTuple» tel quel et «créez» le document avec «sphinx»?
.. autoclass:: simplesqlite.sample.NamedTuple
:members:
:undoc-members:
C'est devenu comme suit. Les membres sont affichés, mais il n'y a pas de quantité d'informations si seules les explications des membres sont automatiquement sorties.
Essai 2
Certaines personnes ont eu le même défi.
Adding docstrings to namedtuples in Python? - Stack Overflow http://stackoverflow.com/questions/1606436/adding-docstrings-to-namedtuples-in-python
Plusieurs méthodes ont été répondues.
Définissons une classe qui hérite de namedtuple et essayons d'écrire une docstring dans la classe.
class NamedTupleWithDocstring1(namedtuple("NamedTuple", "aaa bbb ccc")):
"""
hogehoge
"""
Si vous faites cela avec un sphinx
Ce serait bien d'ajouter l'explication du député à cela.
Dernier
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