Repository navigation
Big rewamp of Documentation with many new additions #899
Workflow file for this run
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: HTTomo docs | |
| on: | |
| workflow_dispatch: | |
| pull_request: | |
| branches: | |
| - main | |
| push: | |
| branches: | |
| - main | |
| tags: | |
| - 'v*' | |
| schedule: | |
| - cron: '0 6 * * 1' | |
| jobs: | |
| build-docs-publish: | |
| runs-on: ubuntu-latest | |
| defaults: | |
| run: | |
| shell: bash -el {0} | |
| steps: | |
| - name: Checkout repository code | |
| uses: actions/checkout@v5 | |
| - name: Setup Python 3.12 | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.12' | |
| - name: httomo-docs | |
| uses: mamba-org/setup-micromamba@v2 | |
| with: | |
| environment-name: httomo-docs | |
| environment-file: ./docs/source/doc-conda-requirements.yml | |
| post-cleanup: 'all' | |
| init-shell: bash | |
| - name: Install httomo-backends | |
| run: pip install --no-deps -r ./docs/source/doc-pip-requirements.txt | |
| - name: Generate full yaml pipelines using pipeline directives | |
| run: | | |
| python ./docs/source/scripts/execute_pipelines_build.py -o ./docs/source/pipelines_full/ | |
| python ./docs/source/scripts/modify_pipeline.py -i ./docs/source/pipelines_full/tomopy_tomobank.yaml | |
| python ./docs/source/scripts/modify_pipeline.py -i ./docs/source/pipelines_full/FBP3d_tomobar_tomobank.yaml | |
| - name: Create ZIP archive for pipelines | |
| run: | | |
| zip -r pipelines_full_artifact.zip ./docs/source/pipelines_full/ | |
| - name: Build docs | |
| run: sphinx-build -W --keep-going -a -E -b html ./docs/source/ ./docs/build/ | |
| - name: Check external links | |
| if: github.event_name == 'schedule' | |
| run: sphinx-build -W --keep-going -a -E -b linkcheck ./docs/source/ ./docs/linkcheck/ | |
| - name: Publish docs | |
| if: >- | |
| (github.event_name == 'push' && | |
| (github.ref_type == 'tag' || github.ref_name == 'main')) || | |
| (github.event_name == 'workflow_dispatch' && | |
| github.ref_name == 'main') | |
| run: ghp-import -n -p -f ./docs/build | |
| env: | |
| GITHUB_TOKEN: ${{ github.token }} | |
| - name: Upload artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: full_pipelines-artifact | |
| path: pipelines_full_artifact.zip |