Show rendered conf.py file in build logs #1651
Merged
Conversation
This file contains hidden or 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
|
This seems like a hacky solution to this, but I don't have a great suggestion otherwise. It would be great to have some kind of "meta build information" in the UI -- but maybe that's just cluttering things up and this is the most straightforward. I think this is a good first step in this direction, and we can make it more clever later. |
|
I guess the better way would be to drive rtd-build and try to remove the necessity of having any project specific |
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.
We had some tickets in the past resulting from users that didn't realize that Sphinx options might get overridden with the code that gets appended to the conf.py before every build (for example #1622, #885).
This PR includes the resulting conf.py as part of the build log in the users project panel and therefore increases the visibility a lot. I assume this will reduce confusion about what happens with the conf.py in the future.
It looks like this:
