-
Привет! Хочу создать по проекту документацию. Раньше работал с Doxygen'ом. Там смысл был расставить нужные строчки перед классами, методами и переменными и Doxygen сам собирал информацию о коде, строил дерево наследования классов, создавал нужные странички и т.п. В итоге html книжка.
А как документировать проект Sphinx'ом? Скачал, почитал... Хмм.. Вроде как это просто для преобразования .rst в другие форматы... Т.е. код он никак не анализирует и сам ничего не рисует? Или что то не понял.
Подскажите вообщем как нужно правильно документировать проект чтобы из него в будуещем получилась красивая "html" книжка. -
Похожий на Doxygen продукт - Epydoc.
-
Т.е. Sphinx не подойдет? А как же тогда получается Django документирована? Там же Sphinx... Ммм... Посмотрел, у них вообще автодокументации нет. Все ручной работы... Чтож делать то. Может тоже сделать все вручную?
-
Sphinx - для подготовки документации вообще. Допустим, руководства конечного пользователя. Инструмент вроде texinfo или docbook, только на базе разметки RST.
Для документирования API - epydoc.
-
Т.е. Sphinx не подойдет? А как же тогда получается Django документирована? Там же Sphinx... Ммм... Посмотрел, у них вообще автодокументации нет. Все ручной работы... Чтож делать то. Может тоже сделать все вручную?
Так вам нужна документация или как у джанги документация?:-) Что вы мечетесь-то.
-
Вроде понял. Нужно забить на сфинкс и генерировать документацию на апи. Потому как сайт лучше так задокументировать. Или нет? Вы как делаете?
-
Для кого и для чего вы хотите создать документацию?
Озвучьте ваши цели.
-
Хочу документировать сайт и стороннюю библиотеку. По сайту - пока только для себя, библиотеку для себя и других.
-
Кстати, в комплекте со Sphinx идёт расширение autodoc, позволяющее генерировать документацию из docstring'ов.
По-моему, полностью автоматическая документация не слишком-то читабельна. Можно и исходник почитать, раз уж docstring'и хорошо написаны.
Внимание! Это довольно старый топик, посты в него не попадут в новые, и их никто не увидит. Пишите пост, если хотите просто дополнить топик, а чтобы задать новый вопрос — начните новый.