doc overhaul step 2: break main doc into multiple sections #2102
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Did a cut and paste from setuptoo.txt to userguide/quickstart.txt
Did a cut and paste from setuptools.txt
cut-and-paste from setuptools.txt
cut and paste from setuptools.txt
from pointing at setuptools.txt to userguide/index.txt
|
Looking good! Thanks. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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