Skip to content

Quick Start

Быстрый старт: ДЗ 6 — Документация и GitHub Pages

Этот QUICKSTART.md описывает, как воспроизвести документацию и публикацию на GitHub Pages из ДЗ 6. Он соответствует разделам про документацию и GitHub Pages в общем docs/QUICKSTART.md (шаги про MkDocs и workflow docs.yml) и связывает их с отчётом docs/homework_6/REPORT.md.

Убедитесь, что у вас настроен доступ к GitHub (SSH или HTTPS) и есть права на репозиторий M0rtel/engineering_practices_ml.

1. Локальная сборка документации MkDocs

Конфиг документации: mkdocs.yml Исходники: каталог docs/

Соберите документацию локально:

mkdocs build

Для локального просмотра:

mkdocs serve

Откройте в браузере:

  • http://127.0.0.1:8000/

Убедитесь, что: - главная страница открывается, - есть разделы Quick Start, Deployment, отчёты по ДЗ, отчёты об экспериментах.

2. Настройка GitHub Pages

  1. Зайдите в настройки репозитория на GitHub: Settings → Pages
  2. В разделе Source выберите:
  3. Source: GitHub Actions
  4. Сохраните настройки.

После этого GitHub Pages будет использовать workflow из .github/workflows/docs.yml.

3. Проверка workflow публикации документации

Workflow: .github/workflows/docs.yml

Триггеры: - push в main, - изменение файлов в docs/ или mkdocs.yml, - ручной запуск через workflow_dispatch.

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

Затем: - откройте вкладку Actions в GitHub, - найдите workflow Documentation / docs, - убедитесь, что все шаги прошли успешно.

4. Доступ к опубликованной документации

После успешного workflow GitHub Pages будет доступен по адресу:

  • https://M0rtel.github.io/engineering_practices_ml/

Проверьте: - открывается главная страница, - работают ссылки на отчёты по ДЗ, - отображаются отчёты об экспериментах и графики.

5. Где смотреть детали по ДЗ 6

  • Описание устройства документации и GitHub Pages: docs/homework_6/REPORT.md
  • Скриншоты: docs/homework_6/screenshots/