Skip to content

Add documentation site #11

Add documentation site

Add documentation site #11

permissions:
contents: write
name: Generate Docs with pdoc
on:
push:
branches: [main]
pull_request:
branches: [main]
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: Install dependencies
run: |
echo "scipy==1.10.1" > constraints.txt
pip install -c constraints.txt pdoc
pip install -c constraints.txt -e .
- name: Generate documentation with pdoc
run: |
REPO_NAME=${GITHUB_REPOSITORY##*/}
pdoc --output-dir docs "$REPO_NAME"
- name: Deploy to GitHub Pages
if: github.ref == 'refs/heads/main'
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs