Skip to content

Commit

Permalink
Add a github action for documentation building. (#13)
Browse files Browse the repository at this point in the history
  • Loading branch information
corranwebster authored Sep 13, 2024
1 parent 8301adb commit ef9ed23
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 1 deletion.
25 changes: 25 additions & 0 deletions .github/workflows/build_docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: "Pull Request Docs Check"

on:
- workflow_dispatch
- pull_request

jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python 3.11
uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install dependencies and local packages
run: python -m pip install sphinx pydata-sphinx-theme
- name: Build HTML documentation with Sphinx
run: make html
working-directory: docs
- uses: actions/upload-artifact@v4
with:
name: documentation
path: docs/build/html
retention-days: 7
1 change: 0 additions & 1 deletion dev-requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,3 @@ micropy-cli
mpremote
pydata-sphinx-theme
sphinx
unittest

0 comments on commit ef9ed23

Please sign in to comment.