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

quickstart: recommend PyPA build instead of pep517.build #2552

Merged
merged 1 commit into from
Feb 28, 2021
Merged

quickstart: recommend PyPA build instead of pep517.build #2552

merged 1 commit into from
Feb 28, 2021

Conversation

hexagonrecursion
Copy link
Contributor

Summary of changes

Docs update to recommend PyPA build instead of pep517.build (see pypa/pyproject-hooks#91). Similar to #2504 but for docs/userguide/quickstart.rst

@hexagonrecursion
Copy link
Contributor Author

I think this is too minor to deserve a changelog entry.

@hexagonrecursion
Copy link
Contributor Author

Nope. Not done. Now I get:

Warning, treated as error:
/home/user/git/docs/userguide/quickstart.rst:62:Mismatch: both interpreted text role prefix and reference suffix.
ERROR: InvocationError for command /home/user/git/.tox/docs/bin/python -m sphinx -W . /home/user/git/build/html (exited with code 2)

and I have no idea what this means and how to fix this. Searching did not yield anything helpful either yet.

@hexagonrecursion
Copy link
Contributor Author

30 minutes: how log it took me to figure out that I should remove the _. The error message could use improvement.

@hexagonrecursion
Copy link
Contributor Author

Sorry for acting unprofessionally. I have no idea why I'm in a bad mood today.

webknjaz
webknjaz reviewed Feb 8, 2021
View reviewed changes
docs/conf.py Outdated
Comment on lines 1 to 7
extensions = [
'sphinx.ext.autodoc',
'jaraco.packaging.sphinx',
'rst.linker',
'sphinx.ext.intersphinx',
'sphinx.ext.extlinks',
]
Copy link
Member

Choose a reason for hiding this comment

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

Please revert this change, the top part of this module is merged-in from the shared skeleton, and changing it will mess things up for the maintainers.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There should be a comment in conf.py warning contributors about the skeleton

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

Copy link
Member

@webknjaz webknjaz Feb 9, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

Yeah, probably. But it'd need to go to https://github.com/jaraco/skeleton first. This is something @jaraco may want to address separately.

webknjaz
webknjaz approved these changes Feb 9, 2021
View reviewed changes
Copy link
Member

@webknjaz webknjaz left a comment

Choose a reason for hiding this comment

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

LGTM ❤️

@webknjaz webknjaz requested a review from jaraco February 9, 2021 18:57
@jaraco jaraco merged commit dd351c9 into pypa:main Feb 28, 2021
@jaraco
Copy link
Member

jaraco commented Feb 28, 2021

Thanks for the PR and the thoughtful review.

@hexagonrecursion hexagonrecursion deleted the patch-1 branch March 1, 2021 07:13
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 approved these changes

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

Successfully merging this pull request may close these issues.
3 participants
@hexagonrecursion @jaraco @webknjaz