Skip to content

Improves persistence documentation #405

Improves persistence documentation

Improves persistence documentation #405

Workflow file for this run

name: documentation
on:
push:
branches:
- main # Triggers the workflow on push events to the main branch
pull_request:
# Triggers the workflow on pull request events for any branch
types: [ opened, synchronize, reopened ]
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
- name: Install dependencies
run: |
pip install -e ".[documentation]"
- name: Sphinx build
run: |
sphinx-build docs -b dirhtml _build
echo "burr.dagworks.io" > _build/CNAME # keep the cname file which this clobbers -- todo, unhardcode
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/
force_orphan: true