Перейти к содержанию

Версионирование документации

Документация начинается с версии 0.8 и использует mike для публикации нескольких сборок MkDocs в ветку gh-pages. Английская и русская версии собираются вместе для каждого выпуска.

Локальный просмотр

uv sync --group dev
uv run mkdocs serve

Публикация 0.8

uv run mike deploy --push --update-aliases 0.8 latest
uv run mike set-default --push latest

Следующий выпуск

Обновите документацию вместе с исходным кодом, затем опубликуйте новую minor-версию, не удаляя 0.8:

uv run mike deploy --push --update-aliases 0.9 latest

Используйте major/minor версии документации, если patch-релиз не меняет публичное поведение. Не редактируйте сгенерированные файлы в gh-pages: меняйте docs/ и повторяйте deploy.