Skip to content

Workflow file for this run

name: Build and Deploy Sphinx Documentation
on:
push:
branches:
- main
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout Code
uses: actions/checkout@v2
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.x'
- name: Install Poetry
run: curl -sSL https://install.python-poetry.org | python3 -
- name: Configure Poetry to create virtualenvs in project root
run: poetry config virtualenvs.in-project true
- name: Install dependencies
run: poetry install --no-root
- name: Install Dependencies
run: |
python -m pip install --upgrade pip
pip install toml sphinx sphinx_rtd_theme myst-parser
- name: Build Documentation
run: |
cd .sphinx
make html
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./.sphinx/docs/html