Skip to content

Commit

Permalink
Direct action workflow for documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
iamgroot42 committed Dec 31, 2023
1 parent 068628c commit dba4562
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 12 deletions.
29 changes: 23 additions & 6 deletions .github/workflows/generate_documentation.yml
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
6 changes: 0 additions & 6 deletions .scripts/documentation.sh

This file was deleted.

0 comments on commit dba4562

Please sign in to comment.