Guide users to the YAML config from the build detail page #5519
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ericholscher
approved these changes
Mar 22, 2019
There was a problem hiding this comment.
This feels like a great place to remind folks -- perhaps we could even do it in the emails we send about build failures, Travis does little callouts there for new features.
On a semi-related note, I know we support the YAML file being named .?readthedocs.ya?ml but I think we should recommend one particular way even if we support multiple. I'm propose we recommend .readthedocs.yml. Opinions?
I'm +1 on standardizing on .readthedocs.yml when talking about it.
stsewd
approved these changes
Mar 22, 2019
| <strong>Configure your documentation builds!</strong> | ||
| Adding a <a href="{{ config_file_link }}">.readthedocs.yml</a> file to your project | ||
| is the recommended way to configure your documentation builds. | ||
| You can declare dependencies, set up submodules, build for different output formats, and many other great features. |
There was a problem hiding this comment.
build for different output formats
This is only true for sphinx, so not sure if we should advertise it here.
There was a problem hiding this comment.
Ok, I'll drop that one.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a "build idea" to the build detail screen (only for project maintainers) to guide them to using the
.readthedocs.ymlconfiguration file. The message shows regardless of whether the build was successful or not but doesn't show if the build used the v2 YAML file.On a semi-related note, I know we support the YAML file being named
\.?readthedocs.ya?mlbut I think we should recommend one particular way even if we support multiple. I'm propose we recommend.readthedocs.yml. Opinions?Fixes #5500