Skip to content

Added readthedocs action #18

Added readthedocs action

Added readthedocs action #18

Workflow file for this run

name: docs
on:
push:
branches: [main]
pull_request:
branches: [main]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-name: '3.11'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -e .[doc]
- name: Generate API documentation
run: |
sphinx-apidoc -F -o ./docs/docu src
- name: Build documentation
run: |
sphinx-build -E docs ./docs/build
- name: Upload artifacts
uses: actions/upload-artifact@v3
with:
name: html-docs
path: ./docs/build