Skip to content

Commit de3b279

Browse files
committed
update docs configs, requirements and some images
1 parent 17368e4 commit de3b279

File tree

3 files changed

+20
-9
lines changed

3 files changed

+20
-9
lines changed

.readthedocs.yml

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,29 @@
1+
# .readthedocs.yaml
12
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
24

35
# Required
46
version: 2
57

8+
# Set the version of Python and other tools you might need
9+
build:
10+
os: ubuntu-22.04
11+
tools:
12+
python: "3.11"
13+
# You can also specify other tool versions:
14+
# nodejs: "19"
15+
# rust: "1.64"
16+
# golang: "1.19"
17+
618
# Build documentation in the docs/ directory with Sphinx
719
sphinx:
8-
configuration: docs/conf.py
20+
configuration: docs/conf.py
921

10-
# Optionally build your docs in additional formats such as PDF
22+
# If using Sphinx, optionally build your docs in additional formats such as PDF
1123
formats:
12-
- pdf
24+
- pdf
1325

14-
# Optionally set the version of Python and requirements required to build your docs
26+
# Optionally declare the Python requirements required to build your docs
1527
python:
16-
version: "3.8"
17-
install:
18-
- requirements: docs/requirements.txt
28+
install:
29+
- requirements: docs/requirements.txt

docs/_static/canvas-full-demo.png

15.7 KB
Loading

docs/requirements.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
Sphinx==4.0.3
2-
sphinx-rtd-theme==1.0.0
1+
Sphinx==6.2.1
2+
sphinx-rtd-theme==1.2.1

0 commit comments

Comments
 (0)