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.

Sign up for GitHub

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

Jump to bottom

Fix error uploading Sphinx doc with upload_docs. Fixes #1060 #2573

Merged
merged 4 commits into from
Feb 20, 2021
Merged

Fix error uploading Sphinx doc with upload_docs. Fixes #1060 #2573

merged 4 commits into from
Feb 20, 2021

Conversation

melissa-kun-li
Copy link
Contributor

@melissa-kun-li melissa-kun-li commented Feb 19, 2021 •
edited

Summary of changes

Closes #1060

Sphinx now uses builder_target_dirs in replacement of builder_target_dir https://github.com/sphinx-doc/sphinx/blob/3.x/sphinx/setup_command.py#L143-L145. This fix will set the target_dir in upload_docs to the path of the html builder.

Note: Upload_docs was restored support for sites other than PyPi as noted here: https://github.com/pypa/setuptools/blob/e1ffc2abbae4f2aa78dd09ee9827d754b7702b7b/CHANGES.rst#v3610

Pull Request Checklist

jaraco
jaraco approved these changes Feb 20, 2021
View reviewed changes
Copy link
Member

@jaraco jaraco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR is well done. Thanks for putting together the test, which clearly was a lot more effort than the fix itself (not an uncommon scenario). I have no major concerns and just a few comments for your consideration, then we're ready to merge.

@melissa-kun-li
Copy link
Contributor Author

@jaraco Thank you for mentoring me through it!

@jaraco
Copy link
Member

jaraco commented Feb 20, 2021

Very nice. Thorough and thoughtful work.

@jaraco jaraco merged commit d31f7f0 into pypa:main Feb 20, 2021
This was referenced Mar 8, 2021
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jaraco jaraco jaraco approved these changes

@webknjaz webknjaz webknjaz left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

upload_docs raises AttributeError with Sphinx 1.6
3 participants
@melissa-kun-li @jaraco @webknjaz