22name : Documentation
33
44on :
5- # Runs on pushes targeting the default branch
65 push :
76 branches : ["master"]
8-
7+ workflow_call :
98 # Allows you to run this workflow manually from the Actions tab
109 workflow_dispatch :
1110
@@ -22,12 +21,12 @@ concurrency:
2221 cancel-in-progress : false
2322
2423jobs :
25- # Single deploy job since we're just deploying
2624 deploy :
2725 environment :
2826 name : github-pages
2927 url : ${{ steps.deployment.outputs.page_url }}
30- runs-on : ubuntu-latest
28+ # TODO: ubuntu slim enough?
29+ runs-on : ubuntu-slim
3130 steps :
3231 - uses : actions/checkout@v6
3332 - uses : actions/setup-python@v6
@@ -36,19 +35,25 @@ jobs:
3635 - run : |
3736 python -m python -m pip install --upgrade pip
3837 python -m pip install . --group=docs
39- - name : Sphinx APIDoc
40- run : |
41- sphinx-apidoc --force -o docs/source/ .
38+
39+ # TODO: This gets included in docs/conf.py
40+
41+ # - name: Sphinx APIDoc
42+ # run: |
43+ # sphinx-apidoc --force -o docs/source/ .
4244 - name : Sphinx build
4345 run : |
4446 sphinx-build --builder html docs/source/ docs/build/html
45- - name : Setup Pages
46- uses : actions/configure-pages@v5
47- - name : Upload artifact
48- uses : actions/upload-pages-artifact@v4
49- with :
50- # Upload entire repository
51- path : ' ./docs/build/html'
52- - name : Deploy to GitHub Pages
53- id : deployment
54- uses : actions/deploy-pages@v4
47+
48+ # # TODO: From here only on master branch
49+
50+ # - name: Setup Pages
51+ # uses: actions/configure-pages@v5
52+ # - name: Upload artifact
53+ # uses: actions/upload-pages-artifact@v4
54+ # with:
55+ # # Upload entire repository
56+ # path: './docs/build/html'
57+ # - name: Deploy to GitHub Pages
58+ # id: deployment
59+ # uses: actions/deploy-pages@v4
0 commit comments