File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1- name : ' Build Documentation'
2- description : ' Build Sphinx documentation'
1+ name : " Build Documentation"
2+ description : " Build Sphinx documentation"
33inputs :
44 python-version :
5- description : ' Python version to use'
5+ description : " Python version to use"
66 required : false
7- default : ' 3.10'
7+ default : " 3.10"
88 treat-warnings-as-errors :
9- description : ' Treat warnings as errors (-W flag)'
9+ description : " Treat warnings as errors (-W flag)"
1010 required : false
11- default : ' false'
11+ default : " false"
1212runs :
13- using : ' composite'
13+ using : " composite"
1414 steps :
1515 - name : Set up Python
1616 uses : actions/setup-python@v5
Original file line number Diff line number Diff line change 2828 - name : Build documentation
2929 uses : ./.github/actions/build-docs
3030 with :
31- python-version : ' 3.10'
32- treat-warnings-as-errors : ' false'
31+ python-version : " 3.10"
32+ treat-warnings-as-errors : " false"
3333
3434 - name : Setup Pages
3535 uses : actions/configure-pages@v5
Original file line number Diff line number Diff line change 2424 - name : Set up Python
2525 uses : actions/setup-python@v5
2626 with :
27- python-version : ' 3.10'
27+ python-version : " 3.10"
2828
2929 - name : Run pre-commit
3030 uses : pre-commit/action@v3.0.1
5252 - name : Set up Python
5353 uses : actions/setup-python@v5
5454 with :
55- python-version : ' 3.10'
55+ python-version : " 3.10"
5656
5757 - name : Type checking with mypy
5858 run : |
Original file line number Diff line number Diff line change 2424 - name : Build documentation
2525 uses : ./.github/actions/build-docs
2626 with :
27- python-version : ' 3.10'
28- treat-warnings-as-errors : ' true'
27+ python-version : " 3.10"
28+ treat-warnings-as-errors : " true"
2929
3030 - name : Upload docs artifact
3131 uses : actions/upload-artifact@v4
Original file line number Diff line number Diff line change 2121 - name : Set up Python
2222 uses : actions/setup-python@v5
2323 with :
24- python-version : ' 3.10'
24+ python-version : " 3.10"
2525
2626 - name : Cache pip
2727 uses : actions/cache@v4
Original file line number Diff line number Diff line change 2424 - name : Set up Python
2525 uses : actions/setup-python@v5
2626 with :
27- python-version : ' 3.10'
27+ python-version : " 3.10"
2828
2929 - name : Run setup script
3030 run : |
Original file line number Diff line number Diff line change 2121 - name : Set up Python
2222 uses : actions/setup-python@v5
2323 with :
24- python-version : ' 3.10'
24+ python-version : " 3.10"
2525
2626 - name : Cache pip
2727 uses : actions/cache@v4
Original file line number Diff line number Diff line change @@ -19,14 +19,14 @@ cache:
1919 - .cache/pip
2020
2121before_script :
22- - python --version ; pip --version # For debugging
22+ - python --version ; pip --version # For debugging
2323 - pip install virtualenv
2424 - virtualenv venv
2525 - source venv/bin/activate
2626
2727test :
2828 script :
29- - pip install ruff tox # you can also use tox
29+ - pip install ruff tox # you can also use tox
3030 - pip install --editable ".[test]"
3131 - tox -e py,ruff
3232
Original file line number Diff line number Diff line change 66 - id : check-yaml
77 - id : end-of-file-fixer
88 - id : trailing-whitespace
9- - id : check-added-large-files # Prevent giant files from being committed.
9+ - id : check-added-large-files # Prevent giant files from being committed.
1010 args : [--maxkb=500]
11- - id : check-merge-conflict # Check for files that contain merge conflict strings.
11+ - id : check-merge-conflict # Check for files that contain merge conflict strings.
1212 - repo : https://github.com/kynan/nbstripout
1313 rev : 0.9.0
1414 hooks :
15- - id : nbstripout # strip jupyter noteook output
15+ - id : nbstripout # strip jupyter noteook output
1616 - repo : https://github.com/astral-sh/ruff-pre-commit
1717 rev : v0.9.1
1818 hooks :
Original file line number Diff line number Diff line change @@ -28,7 +28,6 @@ template-python
2828
2929# Build docs
3030
31-
3231```
3332make html
3433cd ../
You can’t perform that action at this time.
0 commit comments