Document that readthedocs file can now have yaml extension #4129
Conversation
…eadthedocs-build project
|
Looks like there's a failing check on this. Can you see if you can fix that? |
|
Yep, not sure if I'll manage today. Also there are other tests that broke on the build repo, but pass on my machine 😰 |
readthedocs/doc_builder/config.py
Outdated
| @@ -1,5 +1,5 @@ | |||
| # -*- coding: utf-8 -*- | |||
| """An API to load config from a readthedocs.yml file.""" | |||
| """An API to load config from a 'readthedocs.yml', 'readthedocs.yaml', or '.readthedocs.yml' file.""" | |||
There was a problem hiding this comment.
I think this can remain as readthedocs.yml file, is kind of clear enough that the name can be .rea... etc. Just a thought.
readthedocs/doc_builder/config.py
Outdated
| @@ -134,7 +134,7 @@ def build_image(self): | |||
|
|
|||
| def load_yaml_config(version): | |||
| """ | |||
| Load a configuration from `readthedocs.yml` file. | |||
| Load a configuration from `readthedocs.yml`, `readthedocs.yaml`, or `.readthedocs.yml` file. | |||
There was a problem hiding this comment.
Same here, and those lines are the origin of the linter error (>80 columns)
|
@StefanoChiodino No rush on that. :) Be at ease! |
docs/conda.rst
Outdated
| @@ -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 | |||
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Ok, should we go for readthedocs.yml here? Looks like the simplest option.
|
Can you please rebase/merge against master? We added a new linter for our docs the last week |
docs/conda.rst
Outdated
| @@ -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 | |||
There was a problem hiding this comment.
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.
| - ``readthedocs.yml`` | ||
| - ``readthedocs.yaml`` | ||
| - ``.readthedocs.yml`` |
There was a problem hiding this comment.
List all possible options here.
docs/yaml-config.rst
Outdated
| @@ -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. | |||
There was a problem hiding this comment.
Use only one file name here (the same than in the first paragraph)
Fixes #4102. Documents changes over readthedocs/readthedocs-build#48