-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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.
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
Changes from 1 commit
89dd0e2
0602425
dac21f8
94f3698
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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`` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. List all possible options here. |
||
|
||
Conventions | ||
~~~~~~~~~~~ | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. Choose a reason for hiding this commentThe 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. | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this can remain as |
||
|
||
from __future__ import ( | ||
absolute_import, division, print_function, unicode_literals) | ||
|
@@ -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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same here, and those lines are the origin of the linter error (>80 columns) |
||
|
||
This uses the configuration logic from `readthedocs-build`, which will keep | ||
parsing consistent between projects. | ||
|
There was a problem hiding this comment.
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?There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.