[DOC] deal with several warnings and errors in the doc build #242
Workflow file for this run
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: | |
branches: | |
- master | |
- maint/* | |
- rel/* | |
- docs/* | |
tags: | |
- '*' | |
pull_request: | |
workflow_dispatch: | |
defaults: | |
run: | |
shell: bash | |
# Force tox to use color | |
env: | |
FORCE_COLOR: true | |
concurrency: | |
group: ${{ github.workflow }}-${{ github.ref }} | |
cancel-in-progress: true | |
permissions: | |
contents: read | |
jobs: | |
docs: | |
runs-on: ubuntu-latest | |
strategy: | |
matrix: | |
include: | |
- python-version: '3.11' | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
submodules: recursive | |
fetch-depth: 0 | |
- name: Set up Python ${{ matrix.python-version }} | |
uses: actions/setup-python@v5 | |
with: | |
python-version: ${{ matrix.python-version }} | |
- name: Display Python version | |
run: python -c "import sys; print(sys.version)" | |
- name: Build documentation | |
run: pipx run tox -e docs | |
- name: Upload docs as artifacts | |
uses: actions/upload-artifact@v4 | |
with: | |
path: doc/_build/html | |
- name: Deploy (on tags) | |
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags') | |
uses: peaceiris/actions-gh-pages@v4 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: doc/_build/html | |
force_orphan: true | |
user_name: "BIDS Maintenance" | |
user_email: bids-maintenance@gmail.com |