Skip to content

Commit 53ae71b

Browse files
authored
Create .readthedocs.yml
1 parent 576cfb1 commit 53ae71b

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

.readthedocs.yml

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# .readthedocs.yml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Set the OS, Python version and other tools you might need
9+
10+
build:
11+
os: ubuntu-22.04
12+
tools:
13+
python: "3.10"
14+
15+
# Build documentation in the docs/ directory with Sphinx
16+
# sphinx:
17+
# configuration: docs/conf.py
18+
19+
# Python environment
20+
python:
21+
install:
22+
# these are needed, because they are not part of standard setup
23+
- requirements: docs/requirements.txt
24+
25+
# Build documentation with MkDocs
26+
mkdocs:
27+
configuration: mkdocs.yml
28+
fail_on_warning: false
29+
30+
# Optionally build your docs in additional formats such as PDF and ePub
31+
formats: all

0 commit comments

Comments
 (0)