Каков стандартный формат документации Sphinx для метода?

Question

Я пытаюсь документировать свой метод с использованием стандартного формата, но в моем поиске я нашел много способов «документировать методы» «стандарт». Мой метод:

@staticmethod 
def validateMasterAttribute(attribute): 
    ... 

и в соответствии с this official Python documentation я должен документировать это следующим образом:

@staticmethod 
def validateMasterAttribute(attribute): 
    """ Validate that the entered master attribute has all the required nodes 

    Keyword arguments: 
    attribute -- type lxml.etree._Element, it is the xml node for the master attribute 

    Return: 
    Nothing if the node contains all the required sub nodes. Otherwise, it throws a TagNotFoundException exception 
    """ 
    ... 

однако, написано в this question, что я должен документировать это нравится:

@staticmethod 
def validateMasterAttribute(attribute): 
    """ 

    Validate that the entered master attribute has all the required nodes 
    :attribute: type lxml.etree._Element, it is the xml node for the master attribute 
    return: Nothing if the node contains all the required sub nodes. Otherwise, it throws a TagNotFoundException exception 
    """ 
    ... 

Я также нашел другой формат docstring, который кажется старым. Какой формат Sphinx может анализировать и генерировать веб-страницы?

Answer 1

Возможно, вам понадобится обратиться к Documenting Your Project Using Sphinx.

В качестве альтернативы вы можете использовать Napoleon, который является расширением, поддерживающим синтаксис Google для доктрин.

Выберите один. Быть последовательным.