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