From 7af7f8a68ea4b0f7d45a739273684832fa609935 Mon Sep 17 00:00:00 2001 From: Jeremy Stanley Date: Tue, 5 Dec 2017 17:56:10 +0000 Subject: 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. --- docs/setuptools.txt | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'docs') 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()`` ------------------------- -- cgit v1.2.3