Документация по общедоступному API Sphinx

У меня есть большое количество файлов Python, и я хотел бы создать публичную документацию по API для своего проекта. Все функции, входящие в состав апи, я украсил декоратором.

например:

@api
def post_comment(comment)"
    """ Posts a coment
    """
    pass

В тех же классах есть и другие общедоступные методы. API распределен по нескольким файлам, каждый файл определяет классы с методами, а некоторые методы имеют этот декоратор @api. Как я могу указать Sphinx генерировать документы только для общедоступного API?

5
задан barryhunter 27 April 2012 в 11:49
поделиться