Merge pull request #4129 from StefanoChiodino/master

Document that readthedocs file can now have yaml extension
readthedocs · Jun 18, 2018 · f5e8705 · f5e8705
2 parents bd9cd6a + 94f3698
commit f5e8705
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 3 deletions.
diff --git a/docs/conda.rst b/docs/conda.rst
@@ -15,7 +15,8 @@ Activating Conda
 ----------------
 
 Conda Support is the first feature enabled with :doc:`yaml-config`.
-You can enable it by creating a `readthedocs.yml` file in the root of your repository with the contents:
+You can enable it by creating a `readthedocs.yml` file in the root of your
+repository with the contents:
 
 .. code-block:: yaml
 

diff --git a/docs/design/yaml-file.rst b/docs/design/yaml-file.rst
@@ -86,8 +86,10 @@ The file format is based on the YAML spec 1.2 [#yaml-spec]_
 
 The file must be on the root directory of the repository, and must be named as:
 
-- ``.readthedocs.yml``
 - ``readthedocs.yml``
+- ``readthedocs.yaml``
+- ``.readthedocs.yml``
+- ``.readthedocs.yaml``
 
 Conventions
 ~~~~~~~~~~~

diff --git a/docs/yaml-config.rst b/docs/yaml-config.rst
@@ -2,7 +2,7 @@ Read the Docs YAML Config
 =========================
 
 Read the Docs now has support for configuring builds with a YAML file.
-The file, ``readthedocs.yml`` (or ``.readthedocs.yml``), must be in the root directory of your project.
+The file, ``readthedocs.yml``, must be in the root directory of your project.
 
 .. warning:: This feature is in a beta state.
              Please file an `issue`_ if you find anything wrong.