-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a github action for documentation building. (#13)
- Loading branch information
1 parent
8301adb
commit ef9ed23
Showing
2 changed files
with
25 additions
and
1 deletion.
There are no files selected for viewing
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
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 |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,4 +3,3 @@ micropy-cli | |
mpremote | ||
pydata-sphinx-theme | ||
sphinx | ||
unittest |