Skip to content

confusing/misleading error message when two conf.py files exist #1151

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

Closed
monkeypants opened this issue Feb 9, 2015 · 2 comments
Closed

confusing/misleading error message when two conf.py files exist #1151

monkeypants opened this issue Feb 9, 2015 · 2 comments
Labels
Community Effort Good First Issue Good for new contributors Improvement Minor improvement to code Needed: patch A pull request is required

Comments

@monkeypants
Copy link

This is not a bug, just a very minor feature-tweek request.

I have two conf.py files in my repo (/conf.py and /tmp/conf.py). RTFD was unable to build my docs until I specified "conf.py" as the conf location in the advanced admin tab, rather than letting RTFD locate/choose the conf.py file for me. OK, fair enough, me having two conf.py files is a bit silly.

When the automatic locate/chose feature was failing, the error message in the logs was "unable to find conf.py". I was flumoxed for a while because it was right there, in the root of the repo. If the error said "I can find two conf.py files but don't know which one to use", it would have been much quicker for me to understand and fix the problem.

@agjohnson agjohnson added the Good First Issue Good for new contributors label Feb 12, 2015
@agjohnson
Copy link
Contributor

Our error reporting is lacking in general, we hope to improve this with a slight build refactor. I agree that the message should be more clear. It's low on our lists at the moment, but it'd be great to have a patch for this.

@gregmuellegger gregmuellegger added Improvement Minor improvement to code Community Effort Needed: patch A pull request is required labels Jul 20, 2015
@ericholscher
Copy link
Member

This should be fixed with #1524

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Community Effort Good First Issue Good for new contributors Improvement Minor improvement to code Needed: patch A pull request is required
Projects
None yet
Development

No branches or pull requests

4 participants