Merge pull request #141 from stefmolin/release #39
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
# This workflow builds the Data Morph documentation and publishes it using GitHub pages. | |
# | |
# Based on https://olgarithms.github.io/sphinx-tutorial/docs/8-automating-documentation-updates.html | |
# | |
# Author: Stefanie Molin | |
name: Deploy Docs | |
on: | |
push: | |
branches: [ "main" ] | |
paths: | |
- '.github/workflows/docs.yml' | |
- 'docs/**' | |
- 'src/**' | |
- '!src/data_morph/__main__.py' | |
concurrency: | |
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} | |
cancel-in-progress: true | |
jobs: | |
docs: | |
name: Build and deploy docs. | |
runs-on: ubuntu-latest | |
permissions: | |
contents: write | |
steps: | |
- uses: actions/checkout@v3 | |
with: | |
fetch-depth: 0 | |
- uses: actions/setup-python@v4 | |
with: | |
python-version: "3.x" | |
- name: Install dependencies | |
run: | | |
pip install '.[docs]' | |
- name: Sphinx build | |
run: | | |
git worktree add docs/_build/html gh-pages | |
cd docs | |
make html | |
- name: Deploy docs | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
publish_branch: gh-pages | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: docs/_build/html |