We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent e6f54ab commit 4bc470fCopy full SHA for 4bc470f
1 file changed
.github/workflows/documentation.yml
@@ -0,0 +1,32 @@
1
+name: documentation
2
+
3
+on:
4
+ push:
5
+ branches: [ "main" ]
6
+ pull_request:
7
8
+ workflow_dispatch:
9
10
+permissions:
11
+ contents: write
12
13
+jobs:
14
+ docs:
15
+ runs-on: ubuntu-latest
16
+ steps:
17
+ - uses: actions/checkout@v3
18
+ - uses: actions/setup-python@v3
19
+ - name: Install dependencies
20
+ run: |
21
+ pip install sphinx sphinx_rtd_theme myst_parser
22
+ - name: Sphinx build
23
24
+ sphinx-build doc _build
25
+ - name: Deploy to GitHub Pages
26
+ uses: peaceiris/actions-gh-pages@v3
27
+ if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
28
+ with:
29
+ publish_branch: gh-pages
30
+ github_token: ${{ secrets.GITHUB_TOKEN }}
31
+ publish_dir: _build/
32
+ force_orphan: true
0 commit comments