diff options
| author | Jason R. Coombs <jaraco@jaraco.com> | 2020-05-10 15:41:56 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-05-10 15:41:56 -0400 |
| commit | d2fe06156ed428a2acafb906103736286d0ab844 (patch) | |
| tree | ed3fdbe2d0d8f3bc4ddb2e72da8f2c6234ec36e3 /docs | |
| parent | b185376cb0d7d4ea01a5d69e4d4816548b2fe48a (diff) | |
| parent | d6769eb69b955ad8aa9f7877d782b97ce388f50f (diff) | |
| download | python-setuptools-git-d2fe06156ed428a2acafb906103736286d0ab844.tar.gz | |
Merge pull request #2097 from alvyjudy/improve-doc
doc overhaul step 1: simplify index and group deprecated files
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/deprecated/easy_install.txt (renamed from docs/easy_install.txt) | 0 | ||||
| -rw-r--r-- | docs/deprecated/index.txt | 19 | ||||
| -rw-r--r-- | docs/deprecated/python3.txt (renamed from docs/python3.txt) | 0 | ||||
| -rw-r--r-- | docs/deprecated/python_eggs.txt (renamed from docs/formats.txt) | 0 | ||||
| -rw-r--r-- | docs/index.txt | 12 |
5 files changed, 23 insertions, 8 deletions
diff --git a/docs/easy_install.txt b/docs/deprecated/easy_install.txt index fac7b8fc..fac7b8fc 100644 --- a/docs/easy_install.txt +++ b/docs/deprecated/easy_install.txt diff --git a/docs/deprecated/index.txt b/docs/deprecated/index.txt new file mode 100644 index 00000000..bb6579f8 --- /dev/null +++ b/docs/deprecated/index.txt @@ -0,0 +1,19 @@ +====================================================== +Guides on backward compatibility & deprecated practice +====================================================== + +``Setuptools`` has undergone tremendous changes since its first debut. As its +development continues to roll forward, many of the practice and mechanisms it +had established are now considered deprecated. But they still remain relevant +as a plethora of libraries continue to depend on them. Many people also find +it necessary to equip themselves with the knowledge to better support backward +compatibility. This guide aims to provide the essential information for such +objectives. + +.. toctree:: + :maxdepth: 1 + + python3 + python_eggs + easy_install + diff --git a/docs/python3.txt b/docs/deprecated/python3.txt index 6b55fe78..6b55fe78 100644 --- a/docs/python3.txt +++ b/docs/deprecated/python3.txt diff --git a/docs/formats.txt b/docs/deprecated/python_eggs.txt index 6c0456de..6c0456de 100644 --- a/docs/formats.txt +++ b/docs/deprecated/python_eggs.txt diff --git a/docs/index.txt b/docs/index.txt index 13a46e74..38fbbcc5 100644 --- a/docs/index.txt +++ b/docs/index.txt @@ -14,12 +14,8 @@ designed to facilitate packaging Python projects, where packaging includes: Documentation content: .. toctree:: - :maxdepth: 2 + :maxdepth: 1 - setuptools - pkg_resources - python3 - development - roadmap - Deprecated: Easy Install <easy_install> - history + User guide <setuptools> + Development guide <development> + Backward compatibility & deprecated practice <deprecated/index> |
