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