summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorIan Wienand <iwienand@redhat.com>2018-04-30 19:32:01 +1000
committerStephen Finucane <stephenfin@redhat.com>2018-10-05 13:24:49 +0000
commit77e75e25e383fb8319be7b46eca3d1d10136bc22 (patch)
treeee7b314c27be9ec9d81cd6184a2ae6b6fb957e97 /doc
parentf14a3b2b73c6c95edbea8de799cf1df07decdf0e (diff)
downloadpbr-77e75e25e383fb8319be7b46eca3d1d10136bc22.tar.gz
Special case long_description_content_type
As described in the pypa pull request, special-case passing through these fields into the metadata. setuptools will maintain them. Change-Id: I89eb8c6d627790680a61a0a4b7490191b6e8e90c Closes-Bug: #1762494
Diffstat (limited to 'doc')
-rw-r--r--doc/source/user/features.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/source/user/features.rst b/doc/source/user/features.rst
index dfbc18b..7e2e979 100644
--- a/doc/source/user/features.rst
+++ b/doc/source/user/features.rst
@@ -181,6 +181,10 @@ probably a good long_description. So we'll just inject the contents of your
You can also specify the exact file you want to use using the
``description-file`` parameter.
+You can set the ``description-content-type`` to a MIME type that may
+help rendering of the description; for example ``text/markdown`` or
+``text/x-rst; charset=UTF-8``.
+
Requirements
~~~~~~~~~~~~