File tree 4 files changed +11
-11
lines changed 4 files changed +11
-11
lines changed Original file line number Diff line number Diff line change @@ -3,12 +3,12 @@ Configuration File
3
3
4
4
In addition to using the admin panel of your project to configure your project,
5
5
you can use a configuration file in the root of your project.
6
- The configuration file can be named:
6
+ The configuration file should be named `` .readthedocs.yaml ``.
7
7
8
- - `` readthedocs.yml ``
9
- - `` readthedocs.yaml ``
10
- - `` . readthedocs.yml ``
11
- - `` .readthedocs.yaml ``
8
+ .. note ::
9
+
10
+ Some other variants like `` readthedocs.yaml ``, `` . readthedocs.yml ``, etc
11
+ are deprecated.
12
12
13
13
The main advantages of using a configuration file over the web interface are:
14
14
Original file line number Diff line number Diff line change @@ -15,7 +15,7 @@ Here is an example of what this file looks like:
15
15
16
16
.. code :: yaml
17
17
18
- # .readthedocs.yml
18
+ # .readthedocs.yaml
19
19
20
20
build :
21
21
image : latest
Original file line number Diff line number Diff line change @@ -2,8 +2,8 @@ Configuration File V2
2
2
=====================
3
3
4
4
Read the Docs supports configuring your documentation builds with a YAML file.
5
- The :doc: `configuration file <index >` must be in the root directory of your project.
6
- We recommend the filename ``.readthedocs.yml ``.
5
+ The :doc: `configuration file <index >` must be in the root directory of your project
6
+ an be named ``.readthedocs.yaml ``.
7
7
8
8
All options are applied to the version containing this file.
9
9
Below is an example YAML file which shows the most common configuration options:
@@ -14,7 +14,7 @@ Below is an example YAML file which shows the most common configuration options:
14
14
15
15
.. code :: yaml
16
16
17
- # .readthedocs.yml
17
+ # .readthedocs.yaml
18
18
# Read the Docs configuration file
19
19
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
20
20
@@ -39,7 +39,7 @@ Below is an example YAML file which shows the most common configuration options:
39
39
40
40
.. code :: yaml
41
41
42
- # .readthedocs.yml
42
+ # .readthedocs.yaml
43
43
# Read the Docs configuration file
44
44
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
45
45
Original file line number Diff line number Diff line change @@ -72,7 +72,7 @@ and to troubleshoot any issues that arise.
72
72
73
73
Some documentation projects require additional configuration to build
74
74
such as specifying a certain version of Python or installing additional dependencies.
75
- You can configure these settings in a ``readthedocs.yml `` file.
75
+ You can configure these settings in a ``. readthedocs.yaml `` file.
76
76
See our :doc: `/config-file/index ` docs for more details.
77
77
78
78
It is also important to note that the default version of Sphinx is ``v1.8.5 ``.
You can’t perform that action at this time.
0 commit comments