File tree 1 file changed +48
-0
lines changed
1 file changed +48
-0
lines changed Original file line number Diff line number Diff line change
1
+ # Worfklow to build Sphinx docs and publish them, based on Static HTML workflow
2
+ name : Build Sphinx docs and publish them to GitHub Pages
3
+
4
+ on :
5
+ # Runs on pushes targeting the default branch
6
+ push :
7
+ branches : ["master"]
8
+
9
+ # Allows you to run this workflow manually from the Actions tab
10
+ workflow_dispatch :
11
+
12
+ # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
13
+ permissions :
14
+ contents : read
15
+ pages : write
16
+ id-token : write
17
+
18
+ # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
19
+ # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
20
+ concurrency :
21
+ group : " pages"
22
+ cancel-in-progress : false
23
+
24
+ jobs :
25
+ # Single deploy job since we're just deploying
26
+ deploy :
27
+ environment :
28
+ name : github-pages
29
+ url : ${{ steps.deployment.outputs.page_url }}
30
+ runs-on : ubuntu-latest
31
+ steps :
32
+ - uses : actions/checkout@v4
33
+ - uses : actions/setup-python@v5
34
+ with :
35
+ python-version : ' 3.10'
36
+ - run : pip install sphinx sphinxcontrib-napoleon sphinx-rtd-theme
37
+ - name : Build Sphinx Docs
38
+ run : sphinx-build docs/source/ docs/build/
39
+ - name : Setup Pages
40
+ uses : actions/configure-pages@v4
41
+ - name : Upload artifact
42
+ uses : actions/upload-pages-artifact@v3
43
+ with :
44
+ # Upload entire repository
45
+ path : ' ./docs/build'
46
+ - name : Deploy to GitHub Pages
47
+ id : deployment
48
+ uses : actions/deploy-pages@v4
You can’t perform that action at this time.
0 commit comments