diff options
author | Jason R. Coombs <jaraco@jaraco.com> | 2019-09-11 18:07:45 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-09-11 18:07:45 +0100 |
commit | b3ef77b2085dc8d66d178a2f7d2047a9ca207309 (patch) | |
tree | 59b29ad80ec61296572c53e38443fa91d71dd8bf /docs | |
parent | 7f7780e5b572d6fcacd63bf99389dd9f48c5345c (diff) | |
parent | cb64d3a84fab15aacbdf31a0a5632690ca9f49b2 (diff) | |
download | external_python_setuptools-b3ef77b2085dc8d66d178a2f7d2047a9ca207309.tar.gz external_python_setuptools-b3ef77b2085dc8d66d178a2f7d2047a9ca207309.tar.bz2 external_python_setuptools-b3ef77b2085dc8d66d178a2f7d2047a9ca207309.zip |
Merge branch 'master' into feature/deterministic-provides-extras
Diffstat (limited to 'docs')
-rw-r--r-- | docs/conf.py | 2 | ||||
-rw-r--r-- | docs/developer-guide.txt | 14 | ||||
-rw-r--r-- | docs/setuptools.txt | 45 |
3 files changed, 21 insertions, 40 deletions
diff --git a/docs/conf.py b/docs/conf.py index c7eb6d3f..cbd19fb4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -69,7 +69,7 @@ html_theme_path = ['_theme'] html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -html_sidebars = {'index': 'indexsidebar.html'} +html_sidebars = {'index': ['relations.html', 'sourcelink.html', 'indexsidebar.html', 'searchbox.html']} # If false, no module index is generated. html_use_modindex = False diff --git a/docs/developer-guide.txt b/docs/developer-guide.txt index a5942c8b..d145fba1 100644 --- a/docs/developer-guide.txt +++ b/docs/developer-guide.txt @@ -137,3 +137,17 @@ To build the docs locally, use tox:: .. _Sphinx: http://www.sphinx-doc.org/en/master/ .. _published documentation: https://setuptools.readthedocs.io/en/latest/ + +--------------------- +Vendored Dependencies +--------------------- + +Setuptools has some dependencies, but due to `bootstrapping issues +<https://github.com/pypa/setuptools/issues/980>`, those dependencies +cannot be declared as they won't be resolved soon enough to build +setuptools from source. Eventually, this limitation may be lifted as +PEP 517/518 reach ubiquitous adoption, but for now, Setuptools +cannot declare dependencies other than through +``setuptools/_vendor/vendored.txt`` and +``pkg_reosurces/_vendor/vendored.txt`` and refreshed by way of +``paver update_vendored`` (pavement.py). diff --git a/docs/setuptools.txt b/docs/setuptools.txt index a4e05d75..2e7fe3bd 100644 --- a/docs/setuptools.txt +++ b/docs/setuptools.txt @@ -136,16 +136,18 @@ dependencies, and perhaps some data files and scripts:: author="Me", author_email="me@example.com", description="This is an Example Package", - license="PSF", keywords="hello world example examples", url="http://example.com/HelloWorld/", # project home page, if any project_urls={ "Bug Tracker": "https://bugs.example.com/HelloWorld/", "Documentation": "https://docs.example.com/HelloWorld/", "Source Code": "https://code.example.com/HelloWorld/", - } + }, + classifiers=[ + 'License :: OSI Approved :: Python Software Foundation License' + ] - # could also include long_description, download_url, classifiers, etc. + # could also include long_description, download_url, etc. ) In the sections that follow, we'll explain what most of these ``setup()`` @@ -2234,6 +2236,7 @@ boilerplate code in some cases. license = BSD 3-Clause License classifiers = Framework :: Django + License :: OSI Approved :: BSD License Programming Language :: Python :: 3 Programming Language :: Python :: 3.5 @@ -2679,42 +2682,6 @@ A few important points for writing revision control file finders: inform the user of the missing program(s). -Subclassing ``Command`` ------------------------ - -Sorry, this section isn't written yet, and neither is a lot of what's below -this point. - -XXX - - -Reusing ``setuptools`` Code -=========================== - -``ez_setup`` ------------- - -XXX - - -``setuptools.archive_util`` ---------------------------- - -XXX - - -``setuptools.sandbox`` ----------------------- - -XXX - - -``setuptools.package_index`` ----------------------------- - -XXX - - Mailing List and Bug Tracker ============================ |