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

Apply docs revamp #2397

Merged
merged 81 commits into from
Sep 24, 2020
Merged

Apply docs revamp #2397

merged 81 commits into from
Sep 24, 2020

Conversation

jaraco
Copy link
Member

@jaraco jaraco commented Sep 23, 2020

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.

alvyjudy and others added 30 commits May 10, 2020 14:10
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
jaraco and others added 27 commits May 26, 2020 18:20
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
@jaraco jaraco merged commit cca3e01 into master Sep 24, 2020
@jaraco jaraco deleted the feature/2093-docs-revamp branch September 24, 2020 00:25
@encukou
Copy link
Contributor

encukou commented Sep 30, 2020

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants