Add long_description and long_description_content_type metadata for R…

…EADME to show in pypi.
esdc-esac-esa-int · Jul 15, 2023 · 8e0ab13 · 8e0ab13
1 parent e9d229f
commit 8e0ab13
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/setup.cfg b/setup.cfg
@@ -2,7 +2,6 @@
 name = astroquery
 version = 0.4.7.dev
 description = Functions and classes to access online astronomical data resources
-# FIXME long_description =
 author = The Astroquery Developers
 license = BSD
 url = http://astropy.org/astroquery

diff --git a/setup.py b/setup.py
@@ -15,4 +15,9 @@
 
 from astropy_helpers.setup_helpers import setup
 
-setup()
+# Read the contents of the README file
+from pathlib import Path
+this_directory = Path(__file__).parent
+long_description = (this_directory / "README.rst").read_text()
+
+setup(long_description=long_description, long_description_content_type='text/x-rst')