Skip to content

Commit 7ecfeb2

Browse files
committed
Add Github action
1 parent fae8ca5 commit 7ecfeb2

File tree

2 files changed

+26
-38
lines changed

2 files changed

+26
-38
lines changed
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: documentation
2+
3+
on: [push, pull_request, workflow_dispatch]
4+
5+
permissions:
6+
contents: write
7+
8+
jobs:
9+
docs:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v6
13+
- uses: actions/setup-python@v5
14+
- name: Install uv
15+
uses: astral-sh/setup-uv@v6
16+
- name: Sphinx build
17+
run: |
18+
sphinx-build docs docs/_build
19+
- name: Deploy to GitHub Pages
20+
uses: peaceiris/actions-gh-pages@v4
21+
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
22+
with:
23+
publish_branch: gh-pages
24+
github_token: ${{ secrets.GITHUB_TOKEN }}
25+
publish_dir: docs/_build
26+
force_orphan: true

.gitignore

Lines changed: 0 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,6 @@ __pycache__/
66
# C extensions
77
*.so
88

9-
# Distribution / packaging
10-
.Python
11-
build/
12-
develop-eggs/
13-
dist/
14-
downloads/
15-
eggs/
16-
.eggs/
17-
lib/
18-
lib64/
19-
parts/
20-
sdist/
21-
var/
22-
wheels/
23-
pip-wheel-metadata/
24-
share/python-wheels/
25-
*.egg-info/
26-
.installed.cfg
27-
*.egg
28-
MANIFEST
29-
309
# PyInstaller
3110
# Usually these files are written by a python script from a template
3211
# before PyInstaller builds the exe, so as to inject date/other infos into it.
@@ -51,23 +30,6 @@ coverage.xml
5130
.hypothesis/
5231
.pytest_cache/
5332

54-
# Translations
55-
*.mo
56-
*.pot
57-
58-
# Django stuff:
59-
*.log
60-
local_settings.py
61-
db.sqlite3
62-
db.sqlite3-journal
63-
64-
# Flask stuff:
65-
instance/
66-
.webassets-cache
67-
68-
# Scrapy stuff:
69-
.scrapy
70-
7133
# Sphinx documentation
7234
docs/_build/
7335

0 commit comments

Comments
 (0)