Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .DS_Store
Binary file not shown.
31 changes: 31 additions & 0 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Deploy Doxygen Documentation

on:
push:
branches: [ main ]
pull_request:
branches: [ main ]

jobs:
build-and-deploy:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Doxygen
uses: mattnotmitt/doxygen-action@v1.1.0

- name: Generate Documentation
run: |
cd lab2
doxygen Doxyfile

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: github.ref == 'refs/heads/main'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./lab2/docs/html
destination_dir: docs
Empty file added .nojekyll
Empty file.
51 changes: 51 additions & 0 deletions DEPLOYMENT_GUIDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Руководство по развертыванию документации

## Быстрый старт

### 1. Настройка GitHub Pages
```bash
# 1. Перейдите в настройки репозитория на GitHub
# 2. Pages → Source → GitHub Actions
# 3. Actions → General → Workflow permissions → Read and write permissions
```

### 2. Развертывание
```bash
# Сделайте commit и push изменений
git add .
git commit -m "Add GitHub Pages deployment"
git push origin main
```

### 3. Проверка
- Документация будет доступна по адресу: `https://glebsikunov.github.io/HomeAssignments/`
- Проверьте статус в разделе Actions на GitHub

## Что было настроено

✅ **GitHub Actions workflow** (`.github/workflows/deploy-docs.yml`)
- Автоматическая генерация документации с помощью Doxygen
- Развертывание на GitHub Pages при push в main

✅ **Главная страница** (`index.html`)
- Красивый интерфейс с ссылкой на документацию
- Адаптивный дизайн

✅ **Конфигурация** (`.nojekyll`)
- Корректная работа с файлами, начинающимися с подчеркивания

✅ **Документация** (`lab2/docs/html/`)
- Автоматически генерируемая документация Doxygen
- Доступна по адресу `/docs/`

## Структура URL

- Главная страница: `https://glebsikunov.github.io/HomeAssignments/`
- Документация: `https://glebsikunov.github.io/HomeAssignments/docs/`

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

Документация обновляется автоматически при каждом push в ветку main. Workflow:
1. Устанавливает Doxygen
2. Генерирует документацию из `lab2/`
3. Развертывает в папку `docs/` на GitHub Pages
Loading