Update README.md #14
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
# this file was generated by chatGPT | |
name: Build and Deploy Documentation | |
on: | |
push: | |
branches: | |
- main # Change this to your main branch name | |
pull_request: | |
branches: | |
- main # Change this to your main branch name | |
env: | |
SPHINXOPTS: -W --keep-going | |
jobs: | |
build-and-deploy: | |
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.9" | |
- name: Install Sphinx and Furo | |
run: | | |
python -m pip install --upgrade pip | |
pip install myst-nb furo sphinx-copybutton | |
- name: Build HTML Documentation | |
run: | | |
sphinx-build -b html . docs/_build/html | |
- name: Deploy to GitHub Pages | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
personal_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_branch: gh-pages | |
publish_dir: docs/_build/html |