docs test #20
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: docs | |
| on: | |
| push: | |
| branches: | |
| - main # Change to your default branch | |
| - docs | |
| pull_request: | |
| branches: | |
| - main # Optional: build on pull requests to the main branch | |
| - docs | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v4 | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install sphinx sphinx_rtd_theme | |
| - name: Build the Sphinx documentation | |
| working-directory: ./docs | |
| run: sphinx-apidoc -o . ../src/aviary && make clean && make html | |
| - name: Deploy to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_branch: docs | |
| publish_dir: docs/_build/html |