-
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.
DOC add deployment action + update readme
- Loading branch information
1 parent
f2e1245
commit d142d9c
Showing
2 changed files
with
52 additions
and
5 deletions.
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,49 @@ | ||
jobs: | ||
# Build job | ||
build: | ||
# <Not provided for brevity> | ||
# At a minimum this job should upload artifacts using actions/upload-pages-artifact | ||
|
||
# Deploy job | ||
deploy: | ||
name: Documentation | ||
# Add a dependency to the build job | ||
needs: build | ||
|
||
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment | ||
permissions: | ||
pages: write # to deploy to Pages | ||
id-token: write # to verify the deployment originates from an appropriate source | ||
|
||
# Deploy to the github-pages environment | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
|
||
# Specify runner + deployment step | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v2 | ||
|
||
- name: Set up Python | ||
uses: actions/setup-python@v4 | ||
with: | ||
python-version: 3.12 | ||
architecture: x64 | ||
|
||
- name: Install | ||
run: | | ||
# NOTE: pip, setuptools and wheel should be included with any python | ||
# installation. It's being installed/upgraded here because the | ||
# setup-python action is not including setuptools with Python 3.12 | ||
pip install --upgrade pip setuptools wheel | ||
pip install .[docs] | ||
- name: Build Docs | ||
run: | | ||
cd doc | ||
make html | ||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v4 |
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