-
Notifications
You must be signed in to change notification settings - Fork 8
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
Fix the format of the readthedocs config file. #113
Conversation
Docs were no longer building due to a schema change on readthedocs. Signed-off-by: Jason Guiditta <jguiditt@redhat.com>
Changes build docs successfully. They can be seen here: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM ;)
I'm not seeing the "Changelog" link in the menu of the test docs vs the current docs, when I think it's quite handy to have, but not sure if it's just a test vs real env difference or if there was another format change somewhere.
This is a good observation, and thanks for the review! I did some looking, and I believe this is just because of how I have my test project set up on readthedocs. I have it pointed to a specific branch, and it does a shallow clone, so there are no tags. This causes our tooling which generates the changelog to give this output:
I was able to verify that no tags are present in the checkout when done the way test rtd does it. If we see this is still misbehaving on merge, I will follow up with another patch fixing it, if no objections. |
That sounds absolutely reasonable, thank you for checking and for the explanation! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks for fixing this!
Docs were no longer building due to a schema change on readthedocs.