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

doc overhaul step 2: break main doc into multiple sections #2102

Merged
merged 12 commits into from May 12, 2020
Merged

doc overhaul step 2: break main doc into multiple sections #2102

merged 12 commits into from May 12, 2020

Conversation

alvyjudy
Copy link
Contributor

@alvyjudy alvyjudy commented May 11, 2020

Summary of changes

This is second step on #2093
With cut-and-paste, the content from setuptools.txt file is migrated into five separate files :

  • -quick start (installation & basic use)

  • -commands reference

  • -setup() keywords reference

  • -miscellaneous functionality

  • -declarative config (setup.cfg)

Grouped within a dedicated folder (userguide) and linked together by an index file

The goal of this PR (and a few subsequent ones) is to provide a better road map to the existing documentation BEFORE we actually modify the content. Therefore, the layout presented here is temporary.

Pull Request Checklist

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

@jaraco
Copy link
Member

jaraco commented May 12, 2020

Looking good! Thanks.

@jaraco jaraco merged commit 327eda0 into pypa:feature/2093-docs-revamp May 12, 2020
2 of 5 checks passed
@alvyjudy alvyjudy deleted the doc-2 branch May 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants