Я пытаюсь очистить свою документацию по коду Python и решил использовать sphinx-doc потому что он хорошо выглядит. Мне нравится, как я могу ссылаться на другие классы и методы с помощью таких тегов, как:
:class:`mymodule.MyClass` About my class.
:meth:`mymodule.MyClass.myfunction` And my cool function
Я пытаюсь выяснить, как документировать имена параметров в функции, так что если у меня есть такая функция, как:
def do_this(parameter1, parameter2):
"""
I can describe do_this.
:something?:`parameter1` And then describe the parameter.
"""
Какова наилучшая практика для этого?
Обновление:
Правильный синтаксис:
def do_this(parameter1, parameter2):
"""
I can describe do_this.
:something parameter1: And then describe the variable
"""
