Skip to content

Commit

Permalink
Add github workflow to build, deploy docs
Browse files Browse the repository at this point in the history
  • Loading branch information
leehart committed Sep 18, 2023
1 parent 6dfcac0 commit b3be110
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: docs
on:
push:
branches:
- master
jobs:
docs:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Check out source
uses: actions/checkout@v3

- name: Install Sphinx dependencies
run: |
pip install -r ./docs/requirements.txt
- name: Build HTML
run: |
cd docs/
make html
- name: Deploy HTML to GitHub Pages
uses: peaceiris/[email protected]
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/build/html

0 comments on commit b3be110

Please sign in to comment.