LINUX.ORG.RU
Форум — Development  

Документирование в Python

 


0

3

А как принято у питонистов создавать документацию? Вот, создал и запостил я пакет. Теперь, как понимаю, нужно вручную запостить еще и документацию на http://pythonhosted.org

Вопрос. А какими обычно средствами из https://wiki.python.org/moin/DocumentationTools создается дока? Не слишком ли большой выбор?

Простейшие docstrings присутствуют.

★★★★★

Последнее исправление: dave (всего исправлений: 1)
← Неинициализированные переменные в C++ при использовании разных опций оптимизации g++
QtCreator C++/Python →

Да похоже, что особой необходимости нет. Довольно неплохи pdoc и pydoc. Но хотелось бы чего-нибудь такого же масштаба, как haddock в haskell

dave ★★★★★
() автор топика

Тебе нужен sphinx.

anonymous
()
Ответ на: комментарий от uralbash

Спасибо! Уделю ему внимание тоже

dave ★★★★★
() автор топика

Пользовался doxygen, но только потому что проект был на двух языках (Python, C++).

И если для плюсов doxygen ещё неплох, то для питона ужасен. Просто предостерегаю от неправильного выбора.

Crocodoom ★★★★★
()
Ответ на: комментарий от Crocodoom

Просто предостерегаю от неправильного выбора.

Спасибо! Для этого и создал тему.

Доксигеном я когда-то пользовался, когда приходилось много писать на Си++. Да, мне он тоже не особо понравился

dave ★★★★★
() автор топика
Ответ на: комментарий от redvicka

В Read The Docs, наверное, нужно самому создавать статьи? А мне бы хотелось, чтобы создавалась красивая документация автоматически по docstrings, как я привык в других языках. Сфинкс посмотрю. А вот, к примеру, pdoc весьма неплох: дешево и сердито

dave ★★★★★
() автор топика
Вы не можете добавлять комментарии в эту тему. Тема перемещена в архив.
← Неинициализированные переменные в C++ при использовании разных опций оптимизации g++
Development
QtCreator C++/Python →