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

Что уже известно:

⇒ Документация для просмотра, но не для публикации

Отступление от темы: Makefile

На Википедии

<!> Внимание: на лекции всё рассказывалось наспех! Могу устроить отдельную, или:

Общая идея:

Подсистема документирования Sphinx

Для начала, их много, подсистем документирования даже на Python.

Но, возможно, Sphinx круче всех.

Язык разметки: reStructuredText

Здесь идёт ±воспроизведение методички. Замечания:

sphinx-build-3

Как добавить техническую документацию, выковырянную из исходников:

Остальные расширения

Ах, да: Как писать (несложные) тексты в этом вашем Markdown

Д/З

Семестровый проект должен быть (хотя бы отчасти) документирован.

LecturesCMC/PythonDevelopment2020/07_Documetning (last edited 2020-04-14 08:36:06 by FrBrGeorge)