Skip to content

Use only one variant of the config file #7918

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 16, 2021
Merged

Use only one variant of the config file #7918

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/config-file/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ Configuration File

In addition to using the admin panel of your project to configure your project,
you can use a configuration file in the root of your project.
The configuration file can be named:
The configuration file should be named ``.readthedocs.yaml``.

- ``readthedocs.yml``
- ``readthedocs.yaml``
- ``.readthedocs.yml``
- ``.readthedocs.yaml``
.. note::

Some other variants like ``readthedocs.yaml``, ``.readthedocs.yml``, etc
are deprecated.
Comment on lines +8 to +11
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd vote to remove this completely.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, I was thinking the same, but didn't want to make it disappear just like that and confuse people using an old variant.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems fine for now. We can remove it later. 👍


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

Expand Down
2 changes: 1 addition & 1 deletion docs/config-file/v1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Here is an example of what this file looks like:

.. code:: yaml

# .readthedocs.yml
# .readthedocs.yaml

build:
image: latest
Expand Down
8 changes: 4 additions & 4 deletions docs/config-file/v2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ Configuration File V2
=====================

Read the Docs supports configuring your documentation builds with a YAML file.
The :doc:`configuration file <index>` must be in the root directory of your project.
We recommend the filename ``.readthedocs.yml``.
The :doc:`configuration file <index>` must be in the root directory of your project
an be named ``.readthedocs.yaml``.

All options are applied to the version containing this file.
Below is an example YAML file which shows the most common configuration options:
Expand All @@ -14,7 +14,7 @@ Below is an example YAML file which shows the most common configuration options:

.. code:: yaml

# .readthedocs.yml
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

Expand All @@ -39,7 +39,7 @@ Below is an example YAML file which shows the most common configuration options:

.. code:: yaml

# .readthedocs.yml
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

Expand Down
2 changes: 1 addition & 1 deletion docs/intro/import-guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ and to troubleshoot any issues that arise.

Some documentation projects require additional configuration to build
such as specifying a certain version of Python or installing additional dependencies.
You can configure these settings in a ``readthedocs.yml`` file.
You can configure these settings in a ``.readthedocs.yaml`` file.
See our :doc:`/config-file/index` docs for more details.

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