сфинкс-апидок против автосуммара - PullRequest
0 голосов
/ 01 ноября 2018

Я наталкиваюсь на небольшую кирпичную стену, пытаясь найти лучший способ реализовать автоматическую генерацию документации для проекта Django

Структура моего проекта похожа на следующую:

myproj/           # project root
|- docs/          # docs root
|- myproj/        # package root
   |- app1/
   |- app2/
   |- app3/
   utils.py
   ...

Я хотел бы автоматически сгенерировать документацию для всего в корневом каталоге пакета - и первоначально начал использовать sphinx-apidoc, но затем прочитал что-то, что подразумевало, что я должен вместо этого использовать autosummary и не смог найти никакой информации, описывающей, что Разница между этими двумя вариантами составляет.

1 Ответ

0 голосов
/ 01 ноября 2018

Для всех, кто изо всех сил пытается разобраться в этом, я наконец нашел руководство, которое помогло мне устранить путаницу:

https://romanvm.pythonanywhere.com/post/autodocumenting-your-python-code-sphinx-part-ii-6/

Короче, используйте автосуммару

...