From d666c941369123b3f64442e4a3cdef1eacddc48b Mon Sep 17 00:00:00 2001 From: Pete R Jemian Date: Wed, 15 Sep 2021 13:03:03 -0500 Subject: [PATCH 1/2] DOC #202 --- setup.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 47df7d61..28d3b1ae 100644 --- a/setup.py +++ b/setup.py @@ -3,11 +3,17 @@ import versioneer +description = ( + "Controls for using diffractometers within the" + " Bluesky Framework: https://blueskyproject.io" +) + setup( name="hklpy", version=versioneer.get_version(), cmdclass=versioneer.get_cmdclass(), - description="Controls for using diffractometers within the Bluesky Framework: https://blueskyproject.io", + description=description, + long_description=description, maintainer="prjemian", maintainer_email="prjemian+hklpy@gmail.com", url="https://github.com/bluesky/hklpy", From 8981cb91b3adc943a1fdfa4a380838225b3a548b Mon Sep 17 00:00:00 2001 From: Pete R Jemian Date: Wed, 15 Sep 2021 13:09:08 -0500 Subject: [PATCH 2/2] MNT #202 use README.md --- setup.py | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/setup.py b/setup.py index 28d3b1ae..9b608ab1 100644 --- a/setup.py +++ b/setup.py @@ -3,17 +3,18 @@ import versioneer -description = ( - "Controls for using diffractometers within the" - " Bluesky Framework: https://blueskyproject.io" -) +desc = "Controls for using diffractometers within the Bluesky Framework" +desc += ": https://blueskyproject.io" +with open("README.md", "r") as f: + long_desc = f.read() setup( name="hklpy", version=versioneer.get_version(), cmdclass=versioneer.get_cmdclass(), - description=description, - long_description=description, + description=desc, + long_description=long_desc, + long_description_content_type="text/markdown", maintainer="prjemian", maintainer_email="prjemian+hklpy@gmail.com", url="https://github.com/bluesky/hklpy",