-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Apply docs revamp #2397
Merged
Merged
Apply docs revamp #2397
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
The top index now points to three files: setuptools.txt (user guide), development.txt (development guide) and a WIP index file that is to summarized deprecated practice that remains relevant for backward compatibility.
doc overhaul step 1: simplify index and group deprecated files
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
doc overhaul step 2: break main doc into multiple sections
from quickstart.txt to functionalities.txt
so that the quickstart is cleaner for now. Might add more text later
egg-secutable section moved from userguide/functionalities to deprecated/functionalities
such that each section is comprised of a quick intro and example that illustrate the use of that functionality and provide a link to a more detailed explanation.
outline is completed, now to fill the donut holes
those that don't need to put into a dedicated file are now inside the miscellaneous.txt
Step 4: A PEP517-styled quickstart user guide and room for collaboration
userguide/pkg_discovery.txt now covers find_package, find_namespace package and legacy use of namespace package creation in both setup.py and setup.cfg style
Step 5 on 2093: Package discovery and namespace package userguide now ready
The `decalrative config`_ link present higher in the document is also unresolved, I'm not quite sure what the intended target was.
Coverage 1. console_script 2. plugin support 3. optional dependencies
…tch to imperative voice. Limit to declarative config (setup.cfg) examples.
Step 6 on 2093: userguide on entry points now available
note the use case for tests and docs functions and that "test_require" is deprecated, shorten description of the example
step 7 on 2093: dependency management guide ready
This PR breaks existing URLs like https://setuptools.readthedocs.io/en/latest/distutils-legacy.html (mentioned here for example). Would it be possible to add redirects, at least in Read the Docs? |
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.
In #2093, alvyjudy was working on a revamp of the documentation. That (ambitious) effort has stalled out, but this branch remains. There are some latent issues with the documentation (warnings, duplication), but I'm tempted to merge the changes anyway to stop the divergence from master. Assuming the docs are readable in this form, I'm recommending we merge the changes and work out issues in subsequent iterations.