docs #869
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: 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 19 * * SUN' | |
| jobs: | |
| build_docs: | |
| name: Documentation | |
| runs-on: 'macos-14' | |
| timeout-minutes: 180 | |
| defaults: | |
| run: | |
| shell: bash -l {0} | |
| env: | |
| DESC: "Documentation build" | |
| MPLBACKEND: "Agg" | |
| SETUPTOOLS_ENABLE_FEATURES: "legacy-editable" | |
| MOZ_HEADLESS: 1 | |
| DISPLAY: ":99.0" | |
| PANEL_IPYWIDGET: 1 | |
| steps: | |
| - uses: holoviz-dev/holoviz_tasks/install@v0 | |
| with: | |
| name: doc_build | |
| python-version: "3.11" | |
| channels: pyviz/label/dev,conda-forge,bokeh,nodefaults | |
| conda-update: 'true' | |
| nodejs: true | |
| nodejs-version: 20 | |
| # Remove when all examples tools can be installed on 3.10 | |
| envs: -o examples -o doc -o build | |
| cache: true | |
| opengl: true | |
| - name: doit develop_install | |
| if: steps.install.outputs.cache-hit != 'true' | |
| run: | | |
| conda activate test-environment | |
| pip install --use-deprecated=legacy-resolver pyecharts ipywidgets_bokeh==1.5.0 | |
| - name: bokeh sampledata | |
| run: | | |
| conda activate test-environment | |
| bokeh sampledata | |
| - name: refmanual | |
| run: | | |
| conda activate test-environment | |
| python ./doc/generate_modules.py panel -d ./doc/api -n panel -e tests | |
| - name: build docs | |
| run: | | |
| conda activate test-environment | |
| python scripts/gallery/convert_gallery.py | |
| nbsite build --what=html --output=builtdocs --org holoviz --project-name panel | |
| cp -r ./panel/dist ./builtdocs/panel_dist | |
| - name: convert gallery | |
| run: | | |
| conda activate test-environment | |
| panel convert examples/gallery/*.ipynb doc/how_to/*/examples/*.md --to pyodide-worker --out ./builtdocs/pyodide/ --pwa --index --requirements doc/pyodide_dependencies.json | |
| - name: git status and git diff | |
| run: | | |
| git status | |
| git diff | |
| - name: Set and echo git ref | |
| id: vars | |
| run: | | |
| echo "Deploying from ref ${GITHUB_REF#refs/*/}" | |
| echo "tag=${GITHUB_REF#refs/*/}" >> $GITHUB_OUTPUT | |
| - name: Deploy dev | |
| uses: peaceiris/actions-gh-pages@v3 | |
| 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/panel | |
| publish_dir: ./builtdocs | |
| force_orphan: true | |
| - 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@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./builtdocs | |
| cname: panel.holoviz.org | |
| force_orphan: true |