Я намагаюся використовувати Sphinx для документування Pythonпроект мій, але я борюся з відмінностями між цим інструментом і звичайними інструментами, такими як JavaDoc, які призначені для документування API. Звичайно, я бачу, що у Сфінкса є набагато більше застосувань, ніж документування API, але, здається, його немає у більш простому завданні.
Я вдалося щоб дізнатися, як повідомити Sphinx про структуру вашого пакета, щоб вам не довелося вручну копіювати його у файли ReST. Моя наступна проблема:
Чи можна включити посилання на джерело для всіх класів із Сфінксом?
Звичайно, джерело має бути добре відформатованим, але оскільки Сфінкс використовує пігменти, я не думаю, що це проблема.
Відповіді:
3 для відповіді № 1Подивись на http://sphinx.pocoo.org/latest/ext/viewcode.html.
0 для відповіді № 2
Включити розширення в conf.py.
extensions = ["sphinx.ext.viewcode"]