-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Direct action workflow for documentation
- Loading branch information
1 parent
068628c
commit dba4562
Showing
2 changed files
with
23 additions
and
12 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,19 +1,36 @@ | ||
name: Regenerate documentation on push | ||
name: Generate and Deploy Documentation | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
- main # or your default branch | ||
|
||
jobs: | ||
run-script: | ||
build-documentation: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout Repository | ||
uses: actions/checkout@v3 | ||
|
||
- name: Run Script | ||
- name: Set up Python | ||
uses: actions/setup-python@v3 | ||
with: | ||
python-version: '3.x' # Specify your Python version | ||
|
||
- name: Install pdoc | ||
run: pip install pdoc3 # Install pdoc or pdoc3 | ||
|
||
- name: Generate Documentation | ||
run: | | ||
pdoc --force --template-dir templates -o docs --html mimir | ||
mv docs/mimir/* docs/ | ||
rm -r docs/mimir | ||
- name: Commit and Push Documentation | ||
run: | | ||
chmod +x .scripts/documentation.sh | ||
./.scripts/documentation.sh | ||
git config --local user.email "[email protected]" | ||
git config --local user.name "GitHub Actions" | ||
git add docs/ | ||
git commit -m "Update documentation" -a || exit 0 # Exit if nothing to commit | ||
git push |
This file was deleted.
Oops, something went wrong.