docs #344
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' | |
| type: choice | |
| options: | |
| - dev | |
| - main | |
| - dryrun | |
| required: true | |
| default: dryrun | |
| schedule: | |
| - cron: '0 15 * * SUN' | |
| env: | |
| PYTHON_VERSION: "3.11" | |
| jobs: | |
| conda_build_docs: | |
| name: Documentation:conda | |
| runs-on: 'ubuntu-latest' | |
| timeout-minutes: 120 | |
| defaults: | |
| run: | |
| shell: bash -l {0} | |
| env: | |
| DESC: "Documentation build" | |
| MPLBACKEND: "Agg" | |
| MOZ_HEADLESS: 1 | |
| DISPLAY: ":99.0" | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: conda-incubator/setup-miniconda@v3 | |
| with: | |
| auto-update-conda: true | |
| environment-file: envs/py${{ env.PYTHON_VERSION }}-docs.yaml | |
| activate-environment: hvplotdocs | |
| - name: Set and echo git ref | |
| id: vars | |
| run: | | |
| echo "Deploying from ref ${GITHUB_REF#refs/*/}" | |
| echo "tag=${GITHUB_REF#refs/*/}" >> $GITHUB_OUTPUT | |
| - name: install dev | |
| # To make sure the latest is installed. | |
| run: pip install -e . --no-deps | |
| - name: conda info | |
| run: conda info | |
| - name: conda list | |
| run: conda list | |
| - name: build docs | |
| run: sphinx-build -b html doc builtdocs | |
| - name: report failure | |
| if: failure() | |
| run: cat /tmp/sphinx-*.log | tail -n 100 | |
| - name: Deploy dev | |
| uses: peaceiris/actions-gh-pages@v4 | |
| 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'))) | |
| with: | |
| personal_token: ${{ secrets.ACCESS_TOKEN }} | |
| external_repository: holoviz-dev/hvplot | |
| publish_dir: ./builtdocs | |
| force_orphan: true | |
| exclude_assets: '.doctrees' | |
| - name: Deploy 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'))) | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./builtdocs | |
| cname: hvplot.holoviz.org | |
| force_orphan: true | |
| exclude_assets: '.doctrees' | |
| pip_build_docs: | |
| name: Documentation:pip | |
| runs-on: 'ubuntu-latest' | |
| timeout-minutes: 120 | |
| defaults: | |
| run: | |
| shell: bash -l {0} | |
| env: | |
| DESC: "Documentation build" | |
| MPLBACKEND: "Agg" | |
| MOZ_HEADLESS: 1 | |
| DISPLAY: ":99.0" | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| - name: install | |
| run: pip install -v --prefer-binary -e ."[doc, examples, geo]" | |
| - name: pip list | |
| run: pip list | |
| - name: Set and echo git ref | |
| id: vars | |
| run: | | |
| echo "Deploying from ref ${GITHUB_REF#refs/*/}" | |
| echo "tag=${GITHUB_REF#refs/*/}" >> $GITHUB_OUTPUT | |
| - name: build docs | |
| run: sphinx-build -b html doc builtdocs | |
| - name: report failure | |
| if: failure() | |
| run: cat /tmp/sphinx-*.log | tail -n 100 |