-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ci: Generate documentation on every push to main
This helps having the changes to documentation be visible faster, which is especially useful when we make rapid and frequent changes to it. Signed-off-by: Gus Monod <[email protected]>
- Loading branch information
1 parent
3edc7ef
commit 8425835
Showing
2 changed files
with
38 additions
and
31 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,38 @@ | ||
name: Publish docs | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
|
||
jobs: | ||
publish_docs: | ||
name: Publish docs | ||
runs-on: ubuntu-latest | ||
#if: github.event_name == 'release' && github.event.action == 'published' | ||
permissions: | ||
contents: write | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: Set up Python | ||
uses: actions/setup-python@v5 | ||
with: | ||
python-version: "3.10" | ||
- name: Set up dependencies | ||
run: | | ||
sudo apt-get update | ||
sudo apt-get install -qy libdw-dev libelf-dev pkg-config | ||
- name: Install Python dependencies | ||
run: | | ||
python3 -m pip install -r requirements-extra.txt | ||
- name: Install Package | ||
run: | | ||
python3 -m pip install -e . | ||
- name: Build docs | ||
run: | | ||
make docs | ||
- name: Publish docs to GitHub Pages | ||
uses: JamesIves/github-pages-deploy-action@v4 | ||
with: | ||
folder: docs/_build/html | ||
single-commit: true |
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