Skip to content

Commit e773701

Browse files
committed
Use only one variant of the config file
Why `.readthedocs.yaml`? - Configuration files usually start with a `.` so they are hidden in unix like systems. - `.yaml` is the official and recommended extension for yaml files. We could go a little further and use a feature flag to stop finding the other ones. ref #7915
1 parent 958338b commit e773701

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
lines changed

docs/config-file/index.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ Configuration File
33

44
In addition to using the admin panel of your project to configure your project,
55
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``.
77

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.
1212

1313
The main advantages of using a configuration file over the web interface are:
1414

docs/config-file/v1.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Here is an example of what this file looks like:
1515

1616
.. code:: yaml
1717
18-
# .readthedocs.yml
18+
# .readthedocs.yaml
1919
2020
build:
2121
image: latest

docs/config-file/v2.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ Configuration File V2
22
=====================
33

44
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``.
77

88
All options are applied to the version containing this file.
99
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:
1414

1515
.. code:: yaml
1616
17-
# .readthedocs.yml
17+
# .readthedocs.yaml
1818
# Read the Docs configuration file
1919
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
2020
@@ -39,7 +39,7 @@ Below is an example YAML file which shows the most common configuration options:
3939

4040
.. code:: yaml
4141
42-
# .readthedocs.yml
42+
# .readthedocs.yaml
4343
# Read the Docs configuration file
4444
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4545

docs/intro/import-guide.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ and to troubleshoot any issues that arise.
7272

7373
Some documentation projects require additional configuration to build
7474
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.
7676
See our :doc:`/config-file/index` docs for more details.
7777

7878
It is also important to note that the default version of Sphinx is ``v1.8.5``.

0 commit comments

Comments
 (0)