Skip to content

Commit 1aea28c

Browse files
alek-pgmelikov
authored andcommitted
added conf file to build readthedocs page
1 parent 31db7ba commit 1aea28c

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

.readthedocs.yaml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Read the Docs configuration file for Sphinx projects
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
4+
# Required
5+
version: 2
6+
7+
# Set the OS, Python version and other tools we might need
8+
build:
9+
os: ubuntu-24.04
10+
tools:
11+
python: "3.12"
12+
13+
# Build documentation in the "docs/" directory with Sphinx
14+
sphinx:
15+
configuration: docs/conf.py
16+
# Fail on all warnings to avoid broken references
17+
# fail_on_warning: true
18+
19+
# Optionally build docs in additional formats such as PDF and ePub
20+
# formats:
21+
# - pdf
22+
# - epub
23+
24+
# Optional but recommended, declare the Python requirements needed
25+
# to build the documentation
26+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
27+
python:
28+
install:
29+
- requirements: docs/requirements.txt

0 commit comments

Comments
 (0)