Skip to content
Build Documentation

Update sphinx.yml #4

Sign in to view logs

Update sphinx.yml

Update sphinx.yml #4

Workflow file for this run

.github/workflows/sphinx.yml at 191b38a
name: Build Documentation
on: [push]
permissions:
contents: write
jobs:
build-deploy:
defaults:
run:
shell: bash
runs-on:
"ubuntu-latest"
steps:
#----------------------------------------------
# check-out repo and set-up python
#----------------------------------------------
- name: Check out repository
uses: actions/checkout@v4
- name: Set up python
id: setup-python
uses: actions/setup-python@v5
with:
python-version: 1.12
#----------------------------------------------
# ----- install & configure poetry -----
#----------------------------------------------
- name: Install Poetry
uses: snok/install-poetry@v1
with:
virtualenvs-create: true
virtualenvs-in-project: true
#----------------------------------------------
# load cached venv if cache exists
#----------------------------------------------
- name: Load cached venv
id: cached-poetry-dependencies
uses: actions/cache@v4
with:
path: .venv
key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
#----------------------------------------------
# install dependencies if cache does not exist
#----------------------------------------------
- name: Install dependencies
if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
run: |
poetry install --no-interaction --no-root
#----------------------------------------------
# install your root project, if required
#----------------------------------------------
- name: Install library
run: |
poetry install --no-interaction
#----------------------------------------------
# Move sample env file
#----------------------------------------------
- name: Move env file
run: |
mv .env.sample .env
#----------------------------------------------
# Build the docs
#----------------------------------------------
- name: Build documentation
run: |
source $VENV && poetry run task generate_docs
#----------------------------------------------
# Deploy the docs
#----------------------------------------------
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/_build