Update workflow documentation #100
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: Deploy Sphinx Docs | |
on: | |
push: | |
branches: | |
- stable # or the branch where your code resides | |
jobs: | |
deploy: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout the repository | |
uses: actions/checkout@v3 | |
- name: Set up Python | |
uses: actions/setup-python@v4 | |
with: | |
python-version: '3.10' | |
- name: Install dependencies | |
run: | | |
pip install -e . | |
pip install -r docs/requirements.txt | |
pip install sphinx | |
pip install sphinx-rtd-theme | |
pip install myst_parser | |
pip install sphinx-tabs | |
pip install sphinx-reredirects | |
pip install sphinx-issues | |
pip install sphinx-autodoc-typehints | |
- name: Build the documentation | |
run: sphinx-build -b html docs docs/_build/html | |
- name: Deploy to GitHub Pages | |
uses: peaceiris/actions-gh-pages@v4 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: docs/_build/html | |
destination_repo: Lexi-BU/Lexi-BU.github.io | |
destination_branch: main |