Updates getting started docs to point to in-app demo #75
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: 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 |