Работа с документацией

Доступные команды

Основные команды

make docs - Сборка HTML документации
make docs-clean - Очистка собранной документации
make docs-serve - Сборка и запуск локального сервера документации на порту 8000
make docs-open - Открытие собранной документации в браузере

Автоматическое обновление

make docs-watch - Автоматическая пересборка каждые 3 секунды
make docs-watch-simple - Простой режим пересборки каждые 5 секунд

Дополнительные форматы

make docs-pdf - Сборка PDF документации (только для Python < 3.13)
make docs-epub - Сборка EPUB документации (только для Python < 3.13)
make docs-all - Сборка всех поддерживаемых форматов

Проверка качества

make docs-linkcheck - Проверка ссылок в документации

Быстрый старт

Установите зависимости документации:
```
make install-dev
```
Соберите документацию:
```
make docs
```
Откройте документацию в браузере:
```
make docs-open
```

Разработка документации

Для активной разработки документации используйте:

make docs-watch

Это будет автоматически пересобирать документацию каждые 3 секунды при изменениях файлов.

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

docs/ - исходные файлы документации
docs/_build/html/ - собранная HTML документация
docs/_static/ - статические файлы (CSS, изображения)

Особенности

Поддержка Python 3.13+ с автоматическим обходом проблемы с модулем imghdr
Автоматическая обработка предупреждений Sphinx
Русская локализация
Поддержка Markdown и reStructuredText