documentation #112
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: documentation | |
on: | |
push: | |
tags: | |
- 'v*' | |
workflow_dispatch: | |
jobs: | |
make_html: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v3 | |
with: | |
fetch-depth: 0 | |
# - name: Setup packages | |
# if: steps.changed-files-specific.outputs.only_changed != 'true' | |
# uses: ./.github/actions/setup | |
# with: | |
# full_install: false | |
- name: Setup python | |
uses: actions/setup-python@v3 | |
- name: Install dependencies | |
run: pip install -r docs/requirements.txt | |
- name: Build package | |
run: python -m build | |
- name: Sphinx build | |
run: sphinx-build -b html docs/source build | |
- name: Deploy | |
uses: peaceiris/actions-gh-pages@v3 | |
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} || ${{ github.event_name == 'workflow_dispatch' }} | |
with: | |
publish_branch: gh-pages | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: build | |
force_orphan: true | |
# - name: Install Sphinx | |
# run: pip install sphinx==6.2.1 sphinx_rtd_theme | |
# | |
# - name: Install numpy | |
# run: pip install numpy | |
# | |
# - name: Install SimpleITK | |
# run: pip install SimpleITK==2.2.0 | |
# | |
# | |
# - name: Build documentation | |
## if: steps.changed-files-specific.outputs.only_changed != 'true' | |
# run: | | |
# cd docs && make clean && make html SPHINXOPTS="-W" # Fail on warning. |