Skip to content

Commit fc44c42

Browse files
authored
Merge pull request #87 from ichrys03/update-on-docs
Create deploy_docs.yml
2 parents 926fc50 + d73436e commit fc44c42

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

.github/workflows/deploy_docs.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Deploy Sphinx docs to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
jobs:
10+
build-and-deploy:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout repository
14+
uses: actions/checkout@v4
15+
16+
- name: Set up Python
17+
uses: actions/setup-python@v4
18+
with:
19+
python-version: '3.x'
20+
21+
- name: Install dependencies
22+
run: |
23+
python -m pip install --upgrade pip
24+
pip install -r docs/requirements.txt sphinx
25+
26+
- name: Build Sphinx HTML
27+
run: sphinx-build -b html docs docs/_build/html
28+
29+
- name: Deploy to GitHub Pages
30+
uses: peaceiris/actions-gh-pages@v3
31+
with:
32+
github_token: ${{ secrets.GITHUB_TOKEN }}
33+
publish_dir: ./docs/_build/html

0 commit comments

Comments
 (0)