Skip to content

Commit f5e8705

Browse files
authored
Merge pull request #4129 from StefanoChiodino/master
Document that readthedocs file can now have yaml extension
2 parents bd9cd6a + 94f3698 commit f5e8705

File tree

3 files changed

+6
-3
lines changed

3 files changed

+6
-3
lines changed

docs/conda.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ Activating Conda
1515
----------------
1616

1717
Conda Support is the first feature enabled with :doc:`yaml-config`.
18-
You can enable it by creating a `readthedocs.yml` file in the root of your repository with the contents:
18+
You can enable it by creating a `readthedocs.yml` file in the root of your
19+
repository with the contents:
1920

2021
.. code-block:: yaml
2122

docs/design/yaml-file.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,10 @@ The file format is based on the YAML spec 1.2 [#yaml-spec]_
8686

8787
The file must be on the root directory of the repository, and must be named as:
8888

89-
- ``.readthedocs.yml``
9089
- ``readthedocs.yml``
90+
- ``readthedocs.yaml``
91+
- ``.readthedocs.yml``
92+
- ``.readthedocs.yaml``
9193

9294
Conventions
9395
~~~~~~~~~~~

docs/yaml-config.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Read the Docs YAML Config
22
=========================
33

44
Read the Docs now has support for configuring builds with a YAML file.
5-
The file, ``readthedocs.yml`` (or ``.readthedocs.yml``), must be in the root directory of your project.
5+
The file, ``readthedocs.yml``, must be in the root directory of your project.
66

77
.. warning:: This feature is in a beta state.
88
Please file an `issue`_ if you find anything wrong.

0 commit comments

Comments
 (0)