Merge remote-tracking branch 'origin/maintenance_1.4.x' #17
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: | |
| pull_request: | |
| types: [opened, synchronize, reopened, labeled] | |
| push: | |
| branches: | |
| - master | |
| tags-ignore: | |
| - '**' | |
| release: | |
| types: [published] | |
| # cancel previous runs, but only in PRs, do not cancel previous runs if this run will be skipped | |
| concurrency: | |
| group: docs-${{ github.event.pull_request.number || github.run_id }}-${{ !((github.event.action != 'labeled' && contains(github.event.pull_request.labels.*.name, 'build_docs')) || github.event.label.name == 'build_docs') || github.run_id }} | |
| cancel-in-progress: true | |
| jobs: | |
| build: | |
| # only run if on master branch OR if PR is updated and build_docs label present OR if build_docs_label is added | |
| if: github.event_name != 'pull_request' || ((github.event.action != 'labeled' && contains(github.event.pull_request.labels.*.name, 'build_docs')) || github.event.label.name == 'build_docs') | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: setup conda | |
| uses: conda-incubator/setup-miniconda@v3 | |
| with: | |
| miniconda-version: 'latest' | |
| python-version: '3.9' | |
| activate-environment: obspydoc | |
| environment-file: .github/docs_conda_env.yml | |
| - name: install obspy | |
| shell: bash -l {0} | |
| run: | | |
| python -m pip install . | |
| - name: build doc | |
| shell: bash -l {0} | |
| run: | | |
| cd misc/docs | |
| make html | |
| - name: compress docs with tar | |
| shell: bash -l {0} | |
| run: | | |
| cd misc/docs/build/html/ | |
| tar cfJ obspydoc.tar.xz * | |
| - name: actions/upload-artifact@v4 for docs | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: obspydoc | |
| path: misc/docs/build/html/obspydoc.tar.xz | |
| - name: build docset | |
| shell: bash -l {0} | |
| run: | | |
| cd misc/docs | |
| bash make_docset.sh | |
| - name: actions/upload-artifact@v4 for docset | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: obspydocset | |
| path: misc/docs/build/obspy-*.docset.tgz |