Включение источника в документацию Sphinx

Я пытаюсь использовать Sphinx для документирования моего проекта Python, но я борюсь с различиями между этим инструментом и обычными инструментами, такими как JavaDoc, которые предназначены для документирования API. Конечно, я вижу, что у Sphinx гораздо больше применений, чем документирование API, но, похоже, ему не хватает более простой задачи.

Мне удалось узнать, как сообщить Sphinx о структуре вашего пакета, чтобы у вас не было вручную реплицировать его в файлы ReST. Моя следующая проблема:

Можно ли включить ссылку на источник для всех классов со Sphinx?

Конечно, исходник должен быть хорошо отформатирован, но поскольку Sphinx использует pygments, я не думаю, что это проблема.


person Andrea    schedule 16.03.2011    source источник


Ответы (2)


Взгляните на sphinx.ext.viewcode.

person mzjn    schedule 17.03.2011

Включите расширение в conf.py.

extensions = ['sphinx.ext.viewcode']
person Denys Nunes    schedule 04.04.2017