Уведомления

Группа в Telegram: @pythonsu

#1 Июль 15, 2011 11:50:57

Юрчек
От:
Зарегистрирован: 2009-04-14
Сообщения: 45
Репутация: +  0  -
Профиль   Отправить e-mail  

ведение документации

Посоветуйте альтернативу pydoc, чтобы по коду генерировать симпотичные доки в html. Беглый гуглинг показал, что таких инструментов тьма.



Офлайн

#2 Июль 15, 2011 15:38:37

bw
От:
Зарегистрирован: 2007-09-26
Сообщения: 938
Репутация: +  20  -
Профиль   Адрес электронной почты  

ведение документации

Я пользовался только epydoc.
Точнее я комментарии составляю в совместимом (на глаз :-) формате, но генерировать документы приходится крайне редко.
Возможны два типа разметки: свой или ReST (я использую первый, epydoc'овский).

..bw



Офлайн

#3 Июль 15, 2011 15:42:10

Lexander
От:
Зарегистрирован: 2008-09-19
Сообщения: 1139
Репутация: +  33  -
Профиль   Отправить e-mail  

ведение документации

Почему бы не использовать ту, которая используется на сайте Питона:
http://docs.python.org/py3k/about.html



Офлайн

#4 Июль 15, 2011 19:10:10

bw
От:
Зарегистрирован: 2007-09-26
Сообщения: 938
Репутация: +  20  -
Профиль   Адрес электронной почты  

ведение документации

Sphinx не очень подходит для комментирования кода, т.е. для “документации по коду”.
Для создания документации по пакету (рукописной), различных учебников и т.п., годится, но для документирования API, нет.

..bw



Офлайн

#5 Июль 15, 2011 20:20:44

Lexander
От:
Зарегистрирован: 2008-09-19
Сообщения: 1139
Репутация: +  33  -
Профиль   Отправить e-mail  

ведение документации

bw
Так Юрчек именно это и хочет получить: “чтобы по коду генерировать симпотичные доки в html”.

А базовые элементы: параграфы, отступы, - что в PEP257 (Docstring Conventions), что в PEP287 (reStructuredText Docstring Format) одинаковы.



Офлайн

Board footer

Модераторировать

Powered by DjangoBB

Lo-Fi Version