|
| 1 | +# Руководство по развертыванию документации |
| 2 | + |
| 3 | +## Быстрый старт |
| 4 | + |
| 5 | +### 1. Настройка GitHub Pages |
| 6 | +```bash |
| 7 | +# 1. Перейдите в настройки репозитория на GitHub |
| 8 | +# 2. Pages → Source → GitHub Actions |
| 9 | +# 3. Actions → General → Workflow permissions → Read and write permissions |
| 10 | +``` |
| 11 | + |
| 12 | +### 2. Развертывание |
| 13 | +```bash |
| 14 | +# Сделайте commit и push изменений |
| 15 | +git add . |
| 16 | +git commit -m "Add GitHub Pages deployment" |
| 17 | +git push origin main |
| 18 | +``` |
| 19 | + |
| 20 | +### 3. Проверка |
| 21 | +- Документация будет доступна по адресу: `https://glebsikunov.github.io/HomeAssignments/` |
| 22 | +- Проверьте статус в разделе Actions на GitHub |
| 23 | + |
| 24 | +## Что было настроено |
| 25 | + |
| 26 | +✅ **GitHub Actions workflow** (`.github/workflows/deploy-docs.yml`) |
| 27 | +- Автоматическая генерация документации с помощью Doxygen |
| 28 | +- Развертывание на GitHub Pages при push в main |
| 29 | + |
| 30 | +✅ **Главная страница** (`index.html`) |
| 31 | +- Красивый интерфейс с ссылкой на документацию |
| 32 | +- Адаптивный дизайн |
| 33 | + |
| 34 | +✅ **Конфигурация** (`.nojekyll`) |
| 35 | +- Корректная работа с файлами, начинающимися с подчеркивания |
| 36 | + |
| 37 | +✅ **Документация** (`lab2/docs/html/`) |
| 38 | +- Автоматически генерируемая документация Doxygen |
| 39 | +- Доступна по адресу `/docs/` |
| 40 | + |
| 41 | +## Структура URL |
| 42 | + |
| 43 | +- Главная страница: `https://glebsikunov.github.io/HomeAssignments/` |
| 44 | +- Документация: `https://glebsikunov.github.io/HomeAssignments/docs/` |
| 45 | + |
| 46 | +## Автоматическое обновление |
| 47 | + |
| 48 | +Документация обновляется автоматически при каждом push в ветку main. Workflow: |
| 49 | +1. Устанавливает Doxygen |
| 50 | +2. Генерирует документацию из `lab2/` |
| 51 | +3. Развертывает в папку `docs/` на GitHub Pages |
0 commit comments