Skip to content

Add initial content

Add initial content #1

Workflow file for this run

name: Docs
on: [push, pull_request]
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
docs:
runs-on: ubuntu-latest
name: docs
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: "3.11"
cache: 'pip'
- name: Cache dependencies
uses: actions/cache@v3
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('docs/requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-
- run: python -m pip install -r user-guide/requirements.txt
- run: codespell -w user-guide
- name: Build docs
run: |
cd user-guide
sphinx-build -b dirhtml -n -d build/doctrees source build/dirhtml