docs #225
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: docs | |
| on: | |
| push: | |
| tags: | |
| - "v[0-9]+.[0-9]+.[0-9]+" | |
| - "v[0-9]+.[0-9]+.[0-9]+a[0-9]+" | |
| - "v[0-9]+.[0-9]+.[0-9]+b[0-9]+" | |
| - "v[0-9]+.[0-9]+.[0-9]+rc[0-9]+" | |
| workflow_dispatch: | |
| inputs: | |
| target: | |
| description: "Site to build and deploy, or dry-run" | |
| type: choice | |
| options: | |
| - dev | |
| - main | |
| - dryrun | |
| required: true | |
| default: dryrun | |
| schedule: | |
| - cron: "0 14 * * SUN" | |
| jobs: | |
| build_docs: | |
| name: Documentation | |
| runs-on: "ubuntu-latest" | |
| timeout-minutes: 120 | |
| defaults: | |
| run: | |
| shell: bash -el {0} | |
| env: | |
| DESC: "Documentation build" | |
| MPLBACKEND: "Agg" | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }} | |
| AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }} | |
| AWS_DEFAULT_REGION: ${{ secrets.AWS_DEFAULT_REGION }} | |
| MOZ_HEADLESS: 1 | |
| PANEL_EMBED: "true" | |
| PANEL_EMBED_JSON: "true" | |
| PANEL_EMBED_JSON_PREFIX: "json" | |
| steps: | |
| - uses: holoviz-dev/holoviz_tasks/install@v0 | |
| with: | |
| name: Documentation | |
| python-version: "3.10" | |
| channel-priority: flexible | |
| channels: pyviz/label/dev,conda-forge,nodefaults | |
| envs: "-o doc" | |
| cache: true | |
| conda-update: true | |
| - name: Set output | |
| id: vars | |
| run: echo "tag=${GITHUB_REF#refs/*/}" >> $GITHUB_OUTPUT | |
| - name: Download data | |
| run: | | |
| conda activate test-environment | |
| bash scripts/download_data.sh | |
| - name: generate rst | |
| run: | | |
| conda activate test-environment | |
| nbsite generate-rst --org holoviz --project-name holoviews | |
| - name: refmanual | |
| run: | | |
| conda activate test-environment | |
| python ./doc/generate_modules.py holoviews -d ./doc/reference_manual -n holoviews -e tests | |
| - name: build docs | |
| run: | | |
| conda activate test-environment | |
| nbsite build --what=html --output=builtdocs --org holoviz --project-name holoviews | |
| - name: upload dev | |
| if: | | |
| (github.event_name == 'workflow_dispatch' && github.event.inputs.target == 'dev') || | |
| (github.event_name == 'push' && (contains(steps.vars.outputs.tag, 'a') || contains(steps.vars.outputs.tag, 'b') || contains(steps.vars.outputs.tag, 'rc'))) | |
| run: | | |
| pipx install awscli | |
| aws s3 sync --quiet ./builtdocs s3://dev.holoviews.org/ | |
| - name: upload main | |
| if: | | |
| (github.event_name == 'workflow_dispatch' && github.event.inputs.target == 'main') || | |
| (github.event_name == 'push' && !(contains(steps.vars.outputs.tag, 'a') || contains(steps.vars.outputs.tag, 'b') || contains(steps.vars.outputs.tag, 'rc'))) | |
| run: | | |
| pipx install awscli | |
| aws s3 sync --quiet ./builtdocs s3://holoviews.org/ |