Skip to content
Generate docs from templates and docstrings

Remove PyPI token (we'll see on next release if this works) #207

Sign in to view logs

Remove PyPI token (we'll see on next release if this works)

Remove PyPI token (we'll see on next release if this works) #207

Workflow file for this run

.github/workflows/doc.yml at b4ef88e
name: Generate docs from templates and docstrings
on:
push
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: fetch code
uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-python@v5
with:
python-version: '3.12'
- run: pipx install nox
- name: render documents
run: nox -s render_readme render_api_docs
- name: push any changes in current branch
run: |
git config --global user.name 'GitHub Actions'
git config --global user.email 'actions@github.com'
git commit -am 'Generate Documentation [Automated]' && git push || true
- name: push API docs to Github Pages
uses: peaceiris/actions-gh-pages@v3
if: github.ref == 'refs/heads/develop'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./doc/api
commit_message: "Generate API Documentation [Automated]"