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

If mkdocs.yml is broken raise a specific exception and catch it properly #4790

Closed
humitos opened this issue Oct 22, 2018 · 0 comments
Closed
Labels
Improvement Minor improvement to code
Milestone

Comments

@humitos
Copy link
Member

humitos commented Oct 22, 2018

Currently, we are raising BuildEnvironmentError which is too generic and produce the error to be logged into sentry when it's not an app bug but a user configuration problem.

https://github.com/rtfd/readthedocs.org/blob/df85fefc5f59c7a00bcc1ffe23965efe75e8c895/readthedocs/doc_builder/backends/mkdocs.py#L84-L87

We should raise something like MkDocsYAMLError (or a better name) and add it as a warning exception at,

https://github.com/rtfd/readthedocs.org/blob/df85fefc5f59c7a00bcc1ffe23965efe75e8c895/readthedocs/doc_builder/environments.py#L433-L441

@humitos humitos added the Improvement Minor improvement to code label Oct 22, 2018
@humitos humitos added this to the Cleanup milestone Oct 22, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Minor improvement to code
Projects
None yet
Development

No branches or pull requests

1 participant