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

Update documentation for setuptools distribution #1560

Merged
merged 3 commits into from Nov 1, 2018

Conversation

3 participants
@varunkamath18
Contributor

varunkamath18 commented Oct 28, 2018

Summary of changes

  • update setuptools documentatoin with a quick distribution guide.
  • update index to show easy_install and ez_setup to the bottom.
  • move ez_setup instructions to its own file.

Closes #1555

Pull Request Checklist

  • News fragment added in changelog.d. See documentation for details

@pganssle pganssle force-pushed the varunkamath18:feature/docs_clean_user_prereqs branch from 06478aa to e8c9e00 Oct 29, 2018

pganssle added a commit to varunkamath18/setuptools that referenced this pull request Oct 29, 2018

@pganssle

This comment has been minimized.

Member

pganssle commented Oct 29, 2018

I think this branch was maybe based off of the pre-merge version of #1553.

I've cleaned up the history and rebased against master, so @varunkamath18 if you make any further changes please force-pull from your current branch first. Thanks!

@pganssle pganssle force-pushed the varunkamath18:feature/docs_clean_user_prereqs branch from e8c9e00 to 507ec26 Oct 29, 2018

pganssle added a commit to varunkamath18/setuptools that referenced this pull request Oct 29, 2018

@pganssle pganssle force-pushed the varunkamath18:feature/docs_clean_user_prereqs branch from 507ec26 to e8b2699 Oct 29, 2018

pganssle added a commit to varunkamath18/setuptools that referenced this pull request Oct 29, 2018

@varunkamath18

This comment has been minimized.

Contributor

varunkamath18 commented Oct 29, 2018

Right, my bad.

@pganssle

There's one typo that needs to be changed in this, but otherwise I think it can be mostly merged as-is.

I think we may want to play around with the wording of the newly added paragraphs, but that can be in a subsequent PR.

Show resolved Hide resolved docs/setuptools.txt Outdated
Show resolved Hide resolved docs/setuptools.txt

@pganssle pganssle force-pushed the varunkamath18:feature/docs_clean_user_prereqs branch from 8b4ce97 to 6e29e4d Oct 29, 2018

pganssle added a commit to varunkamath18/setuptools that referenced this pull request Oct 29, 2018

@pganssle

Thanks @varunkamath18, for both noticing the issue and making the PR. Everything looks good to go for this PR, so I will merge this when CI passes.

@benoit-pierre

This comment has been minimized.

Member

benoit-pierre commented Oct 29, 2018

Why even bother duplicating the packaging guide section? Just link to it.

I would also remove the ez_setup section completely, since support stopped at 33.1.1 (released more than 1 year ago).

@pganssle

This comment has been minimized.

Member

pganssle commented Oct 29, 2018

@benoit-pierre

Why even bother duplicating the packaging guide section? Just link to it.

During the sprints, I suggested that we have a brief intro to the overall process on our documentation, just so people know what the general recommendation was without having to read the entire tutorial to figure out what's done.

I think that what's in this PR now is more in-depth than I was thinking, but I didn't want to nit-pick about it in this PR, I'd rather get ez_setup out of the main documentation workflow ASAP, then in a subsequent PR tighten up this section of the docs.

I would also remove the ez_setup section completely, since support stopped at 33.1.1 (released more than 1 year ago).

I'm sympathetic to this, but we don't make archived versions of the setuptools documentation available, and I figured a "baby step" would be to move it out of the main documentation - that way, people who want to see how it used to be done (perhaps if they are writing a migration guide or something).

An alternative to this would be to change RTD so that in addition to 'stable' and 'latest', there are also builds for all the minor release tags.

I'm open to removing it completely, though again I'd like to resolve this sooner rather than later, so I'm inclined to merge this (which is a clear improvement to the existing documentation), and have a second PR that trims it down.

varunkamath18 and others added some commits Oct 28, 2018

Update distribution guide and archive ez_setup doc
This adds a simple introductory guide to the modern way to distribute
`setuptools`-based projects with a link to the Python packaging
tutorial.

Rather than delete the old `ez_setup` information, it has been moved to
a separate archive for people who want to use it as a historical
reference.

@pganssle pganssle force-pushed the varunkamath18:feature/docs_clean_user_prereqs branch from 6e29e4d to 4e21a2f Nov 1, 2018

@pganssle

This comment has been minimized.

Member

pganssle commented Nov 1, 2018

Hm, when rebasing this against master, I realized that the move didn't include the changes from #1547. I've incorporated them into the latest version.

That may be one reason to keep these docs around for a bit longer, since we probably still do need to include information about things like bdist_rpm and bdist_deb, even if to just say, "These are deprecated".

@pganssle pganssle added this to Submitted PRs in PyPA Sprint Weekend at Bloomberg (2018) via automation Nov 1, 2018

@pganssle pganssle merged commit 7a8657a into pypa:master Nov 1, 2018

5 checks passed

codecov/patch Coverage not affected when comparing f0cd0ad...4e21a2f
Details
codecov/project 81.65% remains the same compared to f0cd0ad
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
deploy/netlify Deploy preview ready!
Details

PyPA Sprint Weekend at Bloomberg (2018) automation moved this from Submitted PRs to Merged PRs Nov 1, 2018

@pganssle

This comment has been minimized.

Member

pganssle commented Nov 1, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment