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

Строки документации

Техническое документирование

Sphinx

Сайт

Используется для всего, не только для Python.

Пример (см. методичку) / (архив )

BTW: линтер для reStructuredText — тот же rstcheck

Ещё немного советов про Vim + reStructuredText

Оформление docstrnigs

AutoDoc

Пример

Перегенерация API-документации — утилита sphinx-apidoc¶

Хостинг документации

(если успеем):

Документация в программном продукте

Документация на сайте

Д/З

  1. Предусмотреть в семестровом проекте
    • выгонку HTML-документации по API (sphinx.ext.autodoc),

      • это в частности означает наличие в репозитории настроенного каталога для sphinx, в котором что-то выгоняется
    • статическую документацию по проекту (sphinx, wiki, *-pages, что угодно),
    • (пока без публикации)
    • Пример

LecturesCMC/PythonDevelopment2024/08_Documenting (last edited 2024-03-31 21:39:58 by FrBrGeorge)