У меня есть комментарий в моем модуле python, который документирует несколько следующих классов, например,
###
# Classes for agents: patients and clinicians
###
class EngagementLadder(transitions.Machine):
"""The state machine for agent states.
На самом деле, есть несколько таких мультиклассовых комментариев.Каждый служит для разбиения файла, объединяя его в соответствующие разделы.
Я хотел бы видеть эти комментарии в сгенерированной документации, возможно, в виде заголовков.Как это сделать?
Обратите внимание, что мой вопрос похож на В Sphinx, как включить строки документации / комментарии, расположенные в модуле, но вне класса и методов , но ответ, который работалдля него --- поместить его в модуль docstring --- не будет работать для меня, так как я хочу, чтобы эти комментарии дальше в файл.