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

Error "expected string" for None in YAML config #2813

Closed
3 tasks
jaraco opened this issue May 1, 2017 · 1 comment · Fixed by #4461
Closed
3 tasks

Error "expected string" for None in YAML config #2813

jaraco opened this issue May 1, 2017 · 1 comment · Fixed by #4461
Labels
Accepted Accepted issue on our roadmap Bug A bug
Milestone

Comments

@jaraco
Copy link
Contributor

jaraco commented May 1, 2017

In the docs for yaml config, it says that the default for a requirements_file is None. I assumed None meant a Python None or a null value, so I used the YAML syntax of null for the value, but that triggered this build failure.

It's unclear from the docs how one might specify the default value for a setting. Here's what I recommend:

  • Docs for YAML config should specify defaults and example values in YAML syntax (i.e. null for null value).
  • RTD should allow for null values (YAML null or Python None) in config where appropriate.
  • RTD should use native types in YAML config and not encoded values (i.e. literal None string in YAML).

But most essentially, it should be possible to specify the default value for a given setting. I don't believe that's possible given the current implementation (though admittedly, I haven't looked at the implementation itself).

@stsewd
Copy link
Member

stsewd commented Feb 25, 2018

I'm solving this issue on the rtd-build repo readthedocs/readthedocs-build#38

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted Accepted issue on our roadmap Bug A bug
Projects
None yet
4 participants