inf opt #520
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: Build and Deploy Docs | |
on: | |
push: | |
branches: | |
- main # Change this to your default branch if different | |
pull_request: | |
branches: | |
- main # Change this to your default branch if different | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v2 | |
- name: Set up Python | |
uses: actions/setup-python@v2 | |
with: | |
python-version: 3.11.7 | |
- name: Install dependencies | |
run: | | |
python -m pip install --upgrade pip | |
pip install -r docs/requirements.txt | |
- name: Build the documentation | |
run: | | |
sphinx-build -b html docs build/docs | |
- 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: ./build/docs | |
readthedocs: | |
runs-on: ubuntu-latest | |
needs: build | |
steps: | |
- name: Trigger Read the Docs Build | |
env: | |
RTD_PROJECT: ${{ secrets.RTD_PROJECT }} # Replace with your Read the Docs project name | |
RTD_TOKEN: ${{ secrets.RTD_TOKEN }} # Set this secret in your GitHub repository settings | |
run: | | |
curl -X POST -H "Authorization: token $RTD_TOKEN" https://readthedocs.org/api/v2/webhook/torchcell/272672/ | |