← До фільтрів та технологій

← До списку лабораторних по Python

Python Лабораторна 81: Автоматична документація з docstring

Технологія: Python

Номер лабораторної: 81 · Рівень: middle

Тема: Документація коду на Sphinx

Повний опис / сценарій лабораторної:

Meta: навчитися генерувати документацію з docstring щоб команда отримувала актуальний опис API.



Krok 1. Встановити sphinx у віртуальне середовище.

Komandi: cd ~/python_lab1; source .venv/bin/activate; pip install sphinx



Krok 2. Створити каталог docs і ініціалізувати Sphinx через sphinx quickstart.



Krok 3. У конфігурації додати шлях до каталогу src щоб Sphinx бачив модулі.



Krok 4. У кількох модулях проєкту додати якісні docstring у стилі reStructuredText або Google.



Krok 5. У docs створити файл api.rst і додати автоматичні директиви для модулів наприклад automodule.



Krok 6. Запустити збірку документації через make html або sphinx build.



Krok 7. Відкрити згенерований HTML у браузері і перевірити структуру розділів.



Krok 8. Занотувати які модулі вимагають найдетальніших описів для інших розробників.



Krok 9. Продумати як інтегрувати збірку документації у CI щоб не забути оновити її.



Krok 10. Mini zvit.

Zavdannya: опиши правила написання docstring які ти встановиш у команді.