aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJeremy Stanley <fungi@yuggoth.org>2017-12-05 17:56:10 +0000
committerJeremy Stanley <fungi@yuggoth.org>2017-12-05 17:56:10 +0000
commit7af7f8a68ea4b0f7d45a739273684832fa609935 (patch)
treec1c021993b3a2d3687e649f8dc0fb46785fb6805 /docs
parentdf2246449c271c07586bcecc3eaa36e9b0e94e3d (diff)
downloadexternal_python_setuptools-7af7f8a68ea4b0f7d45a739273684832fa609935.tar.gz
external_python_setuptools-7af7f8a68ea4b0f7d45a739273684832fa609935.tar.bz2
external_python_setuptools-7af7f8a68ea4b0f7d45a739273684832fa609935.zip
Document project_urls setup parameter
Add an entry to the Setuptools usage documentation for the project_urls dict, and include it in the "advanced" project example. While at it, adjust the dogfooding use in Setuptools' own setup.py to use HTTPS for the Documentation URL and drop redundant entries for Bug Tracker and Source Code. Also remove a no-op attribute reassignment from egg_info.py.
Diffstat (limited to 'docs')
-rw-r--r--docs/setuptools.txt10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/setuptools.txt b/docs/setuptools.txt
index e3154b46..bea80181 100644
--- a/docs/setuptools.txt
+++ b/docs/setuptools.txt
@@ -145,6 +145,11 @@ dependencies, and perhaps some data files and scripts::
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/",
+ }
# could also include long_description, download_url, classifiers, etc.
)
@@ -408,6 +413,11 @@ unless you need the associated ``setuptools`` feature.
A list of modules to search for additional fixers to be used during
the 2to3 conversion. See :doc:`python3` for more details.
+``project_urls``
+ An arbitrary map of URL names to hyperlinks, allowing more extensible
+ documentation of where various resources can be found than the simple
+ ``url`` and ``download_url`` options provide.
+
Using ``find_packages()``
-------------------------