04.04 Документирование
- reST (не Markdown!)
- Sphinx
- Установка и настройка
- Пример из двух файлов
Задача_1. Текст заявки на семестровый проект превратить в Sphinx-документ - Сохраняя ссылки на репозитории
- Приложить скриншоты на репозитории
- Использовать следующие возможности reST (помимо ссылок и изображений):
- заголовок
- список (нумерованный или маркированный)
- врезка с примером исходного кода (произвольным)
- В качестве решения, в репозиторий с д/з поместить:
- текст на reST
сгенерированное Sphinx-ом дерево файлов HTML-страницы (ВНИМАНИЕ! так обычно не делают, это тестовое задание)
- Autodoc
- Установка
- Оформление docstring для классов, функций/методов и модулей
Особенность: import в процессе порождения документации
- Задача_2. В Д/З по MUD
- Задокументировать все функции, классы и модуль в формате autodoc
- Добиться выгонки технической документации по этим классам/функциям/модулям
- Оформить титульный лист документации (как минимум, скопипастить туда формулировку задачи)
- Сделать в титульном листе ссылку на техническую документацию
Д/З
- Переписать код решения Задачи_2 таки образом, чтобы при формировании документации ничего лишнего из самого проекта не запускалось (если не успели в классе или раньше)
- Оформить обе задачи по стандартным правилам