We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent cff089b commit 2e27121Copy full SHA for 2e27121
.github/workflows/publish_docs.yml
@@ -0,0 +1,30 @@
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
+ defaults:
12
+ run:
13
+ working-directory: ./docs
14
+ steps:
15
+ - uses: actions/checkout@v4
16
+ - uses: actions/setup-python@v5
17
+ - name: Install dependencies
18
+ run: |
19
+ pip install -r requirements.txt
20
+ - name: Sphinx build
21
22
+ make html
23
+ - name: Deploy to GitHub Pages
24
+ uses: peaceiris/actions-gh-pages@v3
25
+ if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
26
+ with:
27
+ publish_branch: gh-pages
28
+ github_token: ${{ secrets.GITHUB_TOKEN }}
29
+ publish_dir: docs/_build/html
30
+ force_orphan: true
0 commit comments