Skip to content

Document that readthedocs file can now have yaml extension #4129

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 4 commits into from
Jun 18, 2018
Merged

Document that readthedocs file can now have yaml extension #4129

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
89dd0e2
Update changes to the 'readthedocs' file extension happening in the r…
StefanoChiodino May 22, 2018
0602425
Don't expand on the possible readthedocs file extensions.
StefanoChiodino May 24, 2018
dac21f8
Merge remote-tracking branch 'main/master'
StefanoChiodino Jun 14, 2018
94f3698
Simplify how the config file is referred to.
StefanoChiodino Jun 16, 2018
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
3 changes: 2 additions & 1 deletion docs/conda.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`, `readthedocs.yaml`, or `.readthedocs.yml` file in the root of your
Copy link
Member

Choose a reason for hiding this comment

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

I think the link the to the yaml docs are fine here and we can just simplify this by Read the Docs configuration file or just .readthedocs.yml. What do you think?

Copy link
Member

Choose a reason for hiding this comment

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

I agree with Santos. We should mention just one possible option here and give more details below by listing all possible options as you have done.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok, should we go for readthedocs.yml here? Looks like the simplest option.

repository with the contents:

.. code-block:: yaml

Expand Down
3 changes: 2 additions & 1 deletion docs/design/yaml-file.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,9 @@ 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``
Copy link
Member

Choose a reason for hiding this comment

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

List all possible options here.


Conventions
~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/yaml-config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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``, ``.readthedocs.yml``, or ``readthedocs.yaml``, must be in the root directory of your project.
Copy link
Member

Choose a reason for hiding this comment

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

Use only one file name here (the same than in the first paragraph)


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