Skip to content
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

Guide users to the YAML config from the build detail page #5519

Merged
merged 2 commits into from Mar 22, 2019

Conversation

@davidfischer
Copy link
Contributor

@davidfischer davidfischer commented Mar 21, 2019

Add a "build idea" to the build detail screen (only for project maintainers) to guide them to using the .readthedocs.yml configuration 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?ml but I think we should recommend one particular way even if we support multiple. I'm propose we recommend .readthedocs.yml. Opinions?

Fixes #5500

Screen Shot 2019-03-21 at 3 55 28 PM

@davidfischer davidfischer requested review from stsewd and Mar 21, 2019
Copy link
Member

@ericholscher ericholscher left a 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
stsewd approved these changes Mar 22, 2019
Copy link
Member

@stsewd stsewd left a comment

I like this ☺️

<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.
Copy link
Member

@stsewd stsewd Mar 22, 2019

build for different output formats

This is only true for sphinx, so not sure if we should advertise it here.

Copy link
Contributor Author

@davidfischer davidfischer Mar 22, 2019

Ok, I'll drop that one.

@ericholscher ericholscher merged commit 83e5149 into master Mar 22, 2019
1 check passed
@delete-merged-branch delete-merged-branch bot deleted the davidfischer/using-latest-config branch Mar 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants