Add initial Sphinx documentation #1
Workflow file for this run
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: Build docs preview | |
on: | |
pull_request: | |
jobs: | |
upload: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up Python ${{ matrix.python-version }} | |
uses: actions/setup-python@v5 | |
with: | |
python-version: 3.12 | |
- name: Build and install package | |
run: pip install . -vv | |
- name: Install documentation dependencies | |
run: pip install -r docs/requirements.txt | |
- name: Build documentation | |
run: sphinx-build docs dist/docs -E -j auto -W --keep-going -T | |
- name: Upload client as artifact | |
uses: actions/upload-artifact@v4 | |
with: | |
name: docs | |
path: | | |
dist/docs/ |