14
Próbuję wyczyścić moją dokumentację kodu Pythona i postanowiłem użyć sphinx-doc, ponieważ wygląda dobrze. Lubię, jak można odwołać innych klas i metod ze znacznikami typu:Jak dokumentować parametry funkcji Pythona za pomocą sphinx-apidoc
:class:`mymodule.MyClass` About my class.
:meth:`mymodule.MyClass.myfunction` And my cool function
próbuję dowiedzieć się, chociaż jak udokumentować nazwy parametrów w funkcji, tak, że jeśli mam funkcji takich jak:
def do_this(parameter1, parameter2):
"""
I can describe do_this.
:something?:`parameter1` And then describe the parameter.
"""
Jaka jest najlepsza praktyka?
Update:
Prawidłowe składni:
def do_this(parameter1, parameter2):
"""
I can describe do_this.
:something parameter1: And then describe the variable
"""
Są to tak zwane "listy pól informacji". Zobacz także http://stackoverflow.com/questions/4547849/good-examples-of-python-docstrings-for-sphinx – gotgenes
Sprawdź [Napolean] (http://www.sphinx-doc.org/en/stable /ext/napoleon.html) rozszerzenie dla Sphinx, które umożliwia ciągi dokumentów w stylu [Google lub Numpy] (http://www.sphinx-doc.org/en/stable/ext/napoleon.html#google-vs- numpy), które wyglądają ładniej niż zwykły Sfinks. – cbare
Interesujące: http://www.pydev.org/manual_adv_type_hints.html –