-
Notifications
You must be signed in to change notification settings - Fork 0
/
.readthedocs.yml
31 lines (28 loc) · 1.06 KB
/
.readthedocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.11"
jobs:
post_create_environment:
# Install poetry et.al.
# https://python-poetry.org/docs/#installing-manually
- pip install poetry jupyter-book sphinx-autoapi toml numpy pandas rustworkx scipy rich matplotlib tqdm ipywidgets
#- pip install --upgrade jupyter
# Tell poetry to not use a virtual environment
- poetry config virtualenvs.create false
post_install:
# Install dependencies with 'docs' dependency group
# https://python-poetry.org/docs/managing-dependencies/#dependency-groups
- poetry install --with docs
pre_build:
# Generate the Sphinx configuration for this Jupyter Book so it builds.
- "jupyter-book config sphinx docs/"
# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/conf.py