-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #47 from umdlife/hotfix/update-documentation
Commit documentation update in workflow
- Loading branch information
Showing
3 changed files
with
17 additions
and
18 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 |
---|---|---|
@@ -1,16 +1,20 @@ | ||
name: Build Documentation | ||
|
||
on: | ||
pull_request: | ||
types: [opened, synchronize, reopened] | ||
|
||
# Runs on pushes targeting the default branch | ||
push: | ||
branches: ["main"] | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
|
||
permissions: | ||
contents: write | ||
steps: | ||
- name: Checkout code | ||
uses: actions/checkout@v4 | ||
with: | ||
ref: main | ||
|
||
- name: Set up Python | ||
uses: actions/setup-python@v5 | ||
|
@@ -25,6 +29,7 @@ jobs: | |
- name: Install Doxygen | ||
run: | | ||
cd .. | ||
wget https://www.doxygen.nl/files/doxygen-1.9.7.linux.bin.tar.gz | ||
tar -xzvf doxygen-1.9.7.linux.bin.tar.gz | ||
cd doxygen-1.9.7 | ||
|
@@ -34,11 +39,9 @@ jobs: | |
run: | | ||
make -C docs html # This assumes your Sphinx configuration is in a 'docs' folder | ||
# - name: Deploy to GitHub Pages (optional) | ||
# Uncomment the following lines if you want to deploy to GitHub Pages | ||
# run: | | ||
# git checkout gh-pages | ||
# cp -r docs/_build/html/* . | ||
# git add . | ||
# git commit -m "Update documentation" | ||
# git push origin gh-pages | ||
- name: Add and commit | ||
uses: EndBug/[email protected] | ||
with: | ||
author_name: UMLDev Robot | ||
author_email: [email protected] | ||
message: 'Update documentation' |
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
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 |
---|---|---|
@@ -1,4 +1,5 @@ | ||
docs/doxyoutput | ||
docs/api | ||
docs/_build/doctrees | ||
|
||
.pre-commit-config.yaml |