mirror of
https://github.com/pybricks/pybricks-api.git
synced 2026-07-28 04:07:46 +00:00
Laurens Valk
578abab24e
This is nowhere near complete, but provides handles to start documenting async for the relevant methods.
26 lines
560 B
YAML
26 lines
560 B
YAML
# .readthedocs.yaml
|
|
# Read the Docs configuration file
|
|
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
|
|
|
|
# Required
|
|
version: 2
|
|
|
|
build:
|
|
os: "ubuntu-22.04"
|
|
tools:
|
|
python: "3.10"
|
|
jobs:
|
|
post_create_environment:
|
|
- pip install poetry
|
|
- poetry config virtualenvs.create false
|
|
post_install:
|
|
- poetry install --only=doc
|
|
|
|
# Build documentation in the doc/main/ directory with Sphinx
|
|
sphinx:
|
|
configuration: doc/main/conf.py
|
|
|
|
# Optionally build your docs in additional formats such as PDF
|
|
formats:
|
|
- pdf
|