Skip to content

Commit ee3f3b8

Browse files
authored
Merge pull request #13 from Gleb-Shall/develope
Add GitHub Pages deployment for Doxygen documentation
2 parents c27b22f + 4f135d7 commit ee3f3b8

25 files changed

Lines changed: 587 additions & 391 deletions

.DS_Store

6 KB
Binary file not shown.

.github/workflows/deploy-docs.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Deploy Doxygen Documentation
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
build-and-deploy:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- name: Checkout
15+
uses: actions/checkout@v4
16+
17+
- name: Setup Doxygen
18+
uses: mattnotmitt/doxygen-action@v1.1.0
19+
20+
- name: Generate Documentation
21+
run: |
22+
cd lab2
23+
doxygen Doxyfile
24+
25+
- name: Deploy to GitHub Pages
26+
uses: peaceiris/actions-gh-pages@v3
27+
if: github.ref == 'refs/heads/main'
28+
with:
29+
github_token: ${{ secrets.GITHUB_TOKEN }}
30+
publish_dir: ./lab2/docs/html
31+
destination_dir: docs

.nojekyll

Whitespace-only changes.

DEPLOYMENT_GUIDE.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
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

Comments
 (0)