Build and deploy documentation #86
This file contains hidden or 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 | |
| run-name: Build and deploy documentation | |
| on: | |
| workflow_dispatch: | |
| # workflow_run: | |
| # workflows: ["Build"] | |
| # branches: [main] | |
| # types: | |
| # - completed | |
| workflow_call: | |
| inputs: | |
| publish: | |
| description: 'Should the Documentation be published?' | |
| required: true | |
| type: string | |
| permissions: | |
| contents: write | |
| jobs: | |
| docs: | |
| name: Build and deploy documentation | |
| runs-on: ubuntu-latest | |
| concurrency: Docs | |
| # if: | | |
| # github.event.workflow_run.conclusion == 'success' || | |
| # github.event_name == 'workflow_dispatch' || | |
| # github.event_name == 'workflow_call' | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| submodules: recursive | |
| - name: Set up Python ${{ vars.MINIMAL_PYTHON_VERSION }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ vars.MINIMAL_PYTHON_VERSION }} | |
| - name: Install dependencies | |
| run: | | |
| pip install -r ./requirements/docs.txt piq scipy scikit-image matplotlib nibabel tqdm | |
| - name: Sphinx build | |
| run: | | |
| sphinx-build docs/source docs/build/html | |
| env: | |
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Deploy to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v4 | |
| if: ${{ github.event_name == 'workflow_dispatch' || inputs.publish == 'true' }} | |
| with: | |
| publish_branch: gh-pages | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: docs/build/html | |
| force_orphan: true |