2013-06-19 3 views
3

Можно ли группировать несколько меток docstrings с помощью sphinx, используя его возможности autodoc, чтобы они были перечислены вместе?Групповой метод docstrings в sphinx

class Test(object): 
    def a(self): 
     """A method of group foo.""" 

    def b(self): 
     """A method of group bar.""" 

    def c(self): 
     """A method of group bar.""" 

    def d(self): 
     """A method of group foo.""" 

В сгенерированной документации a и d должны быть указаны вместе, а также b и c.

+0

Я предполагаю, что вы имеете в виду с 'autodoc'? Как, вы можете положить все, что захотите, в файлы '.rst' ... – mgilson

+0

@mgilson Вот что я имел в виду. Я уточню вопрос, чтобы уточнить. – P3trus

ответ

1

Группируйте методы в исходном модуле и настройте Sphinx для вывода их в указанном порядке, используя autodoc_member_order = 'bysource'.

Я не знаю другого способа группировать членов.

Смежные вопросы