File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Load Diff This file was deleted.
Original file line number Diff line number Diff line change @@ -131,3 +131,42 @@ jobs:
131131 path : |
132132 bandit-report.json
133133 safety-report.json
134+
135+ docs :
136+ name : Build Documentation
137+ runs-on : ubuntu-latest
138+ needs : test
139+ permissions :
140+ contents : write # Needed for GitHub Pages deployment
141+
142+ steps :
143+ - name : Checkout
144+ uses : actions/checkout@v4
145+
146+ - name : Install uv
147+ uses : astral-sh/setup-uv@v4
148+ with :
149+ enable-cache : true
150+
151+ - name : Set up Python
152+ run : uv python install 3.11
153+
154+ - name : Sync dependencies (includes sphinx)
155+ run : uv sync --all-extras --dev
156+
157+ - name : Build documentation
158+ run : uv run sphinx-build -b html docs docs/_build/html
159+
160+ - name : Upload documentation artifacts
161+ uses : actions/upload-artifact@v4
162+ with :
163+ name : documentation
164+ path : docs/_build/html
165+
166+ - name : Deploy to GitHub Pages
167+ if : github.ref == 'refs/heads/main' && github.event_name == 'push'
168+ uses : peaceiris/actions-gh-pages@v3
169+ with :
170+ github_token : ${{ secrets.GITHUB_TOKEN }}
171+ publish_dir : ./docs/_build/html
172+ keep_files : false
Original file line number Diff line number Diff line change @@ -81,3 +81,9 @@ python_version = "3.13"
8181warn_return_any = true
8282warn_unused_configs = true
8383disallow_untyped_defs = true
84+
85+ [dependency-groups ]
86+ dev = [
87+ " sphinx>=8.2.3" ,
88+ " sphinx-rtd-theme>=3.0.2" ,
89+ ]
You can’t perform that action at this time.
0 commit comments