install pangolin #3
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
name: Deploy Documentation | |
on: | |
push: | |
branches: | |
- main # Change to your default branch if it's different | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout code | |
uses: actions/checkout@v2 | |
- name: Set up Python | |
uses: actions/setup-python@v2 | |
with: | |
python-version: '3.12' # Specify your Python version | |
- name: Install dependencies | |
run: | | |
python -m pip install --upgrade pip | |
pip install pdoc | |
pip install -r requirements.txt | |
pip install pangolin | |
- name: Generate Documentation | |
run: | | |
pdoc --docformat numpy -n pangolin -o ./docs | |
- name: Deploy to GitHub Pages | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ./docs | |
publish_branch: gh-pages # Optional: set to a different branch if needed |