File tree Expand file tree Collapse file tree 1 file changed +24
-17
lines changed Expand file tree Collapse file tree 1 file changed +24
-17
lines changed Original file line number Diff line number Diff line change 1
- # .readthedocs.yml
2
- # Read the Docs configuration file
1
+ # Read the Docs configuration file for Sphinx projects
3
2
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4
3
5
4
# Required
6
5
version : 2
7
6
8
- # Build documentation in the docs/ directory with Sphinx
7
+ # Set the OS, Python version and other tools you might need
8
+ build :
9
+ os : ubuntu-22.04
10
+ tools :
11
+ python : " 3.8"
12
+ # You can also specify other tool versions:
13
+ # nodejs: "20"
14
+ # rust: "1.70"
15
+ # golang: "1.20"
16
+
17
+ # Build documentation in the "docs/" directory with Sphinx
9
18
sphinx :
10
19
configuration : docs/source/conf.py
11
-
12
- # Build documentation with MkDocs
13
- # mkdocs:
14
- # configuration: mkdocs.yml
20
+ # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
21
+ # builder: "dirhtml"
22
+ # Fail on all warnings to avoid broken references
23
+ # fail_on_warning: true
15
24
16
25
# Optionally build your docs in additional formats such as PDF and ePub
17
- # formats: all
26
+ # formats:
27
+ # - pdf
28
+ # - epub
18
29
19
- # Optionally set the version of Python and requirements required to build your docs
30
+ # Optional but recommended, declare the Python requirements required
31
+ # to build your documentation
32
+ # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
20
33
python :
21
- version : " 3.8"
22
- install :
23
- - requirements : docs/requirements.txt
24
- # system_packages: true
25
-
26
-
27
- build :
28
- image : stable
34
+ install :
35
+ - requirements : docs/requirements.txt
You can’t perform that action at this time.
0 commit comments