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

Fixed broken paths in tutorial documentation #1033

Merged
merged 1 commit into from Jul 13, 2020
Merged

Fixed broken paths in tutorial documentation #1033

merged 1 commit into from Jul 13, 2020

Conversation

kiancross
Copy link
Contributor

PR for #1032
Fix for bug introduced in #1031.

@kiancross
Copy link
Contributor Author

Warnings should probably be treated as errors when building the documentation (including a non-existent file is a warning not an error). This would then have been caught by the GitHub action which builds the documentation. However, the other superfluous warnings being produced by Sphinx would need to be sorted first.

@Byron Byron merged commit a3ea6c0 into gitpython-developers:master Jul 13, 2020
@Byron
Copy link
Member

Byron commented Jul 13, 2020

Thanks a lot for helping to fix this one!
So many places where releases can go wrong, and thus far GitPython was just pretty lucky.

I agree, it would be great to have sphinx fail instead of ignoring warnings - and I wonder if one could keep only the warnings that are known to be errors, instead of having to fix all the other warnings, in case that get's us to having at least some test earlier.

On the other hand, maybe now we are stable once again so we are good for the years to come.

It seems like latest is now back, but another release is required to fix stable.
Why not :D.

@Byron Byron added this to the v3.1.6 - Bugfixes milestone Jul 13, 2020
@kiancross kiancross deleted the fix-doc-examples branch July 13, 2020 13:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants