Fix pyproject.toml-induced path for docs/generate_html_docs.sh (#546) #7
This file contains hidden or 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: Update API Docs | |
| on: | |
| push: | |
| branches: [dev] | |
| paths: | |
| - 'logger/**/*.py' | |
| - 'server/**/*.py' | |
| - 'docs/generate_html_docs.sh' | |
| - 'docs/pdoc_templates/**' | |
| - 'docs/requirements-docs.txt' | |
| jobs: | |
| build-docs: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.11' | |
| - name: Install dependencies | |
| run: pip install -r docs/requirements-docs.txt | |
| - name: Generate docs | |
| run: bash docs/generate_html_docs.sh | |
| - name: Commit updated docs | |
| run: | | |
| git config user.name "github-actions[bot]" | |
| git config user.email "github-actions[bot]@users.noreply.github.com" | |
| git add docs/html/ | |
| if git diff --cached --quiet; then | |
| echo "No doc changes to commit." | |
| else | |
| git commit -m "docs: regenerate API docs [skip ci]" | |
| git push | |
| fi |