PKG #262 long_description_content_type

README.md

@@ -9,15 +9,6 @@ Writes `path/to/file/specfile.hdf5`
 - Conda install:  `conda install -c conda-forge spec2nexus`
 - Pip install:  `pip install spec2nexus`
 
-**Contents**
-
-- [spec2nexus](#spec2nexus)
-  - [Provides](#provides)
-    - [Applications](#applications)
-    - [Libraries](#libraries)
-  - [Package Information](#package-information)
-  - [NOTE about support for Python version 2](#note-about-support-for-python-version-2)
-
 ## Provides
 
 ### Applications
@@ -26,10 +17,6 @@ Writes `path/to/file/specfile.hdf5`
   Convert [SPEC](https://certif.com) data
   files to [NeXus](https://nexusformat.org) [HDF5](https://hdfgroup.org)
 
-  ```bash
-  ~ $ spec2nexus  path/to/file/specfile.dat
-  ```
-
 - [**extractSpecScan**](https://prjemian.github.io/spec2nexus/extractSpecScan.html) :
   Save columns from SPEC data file scan(s) to TSV files
 
@@ -51,8 +38,8 @@ Writes `path/to/file/specfile.hdf5`
 
 term | description
 --- | ---
-**links** | [documentation](https://prjemian.github.io/spec2nexus),  [release notes](https://github.com/prjemian/spec2nexus/wiki/Release-Notes),  [source code](https://github.com/prjemian/spec2nexus)
 **copyright** | (c) 2014-2022, Pete R. Jemian
+**links** | [documentation](https://prjemian.github.io/spec2nexus),  [release notes](https://github.com/prjemian/spec2nexus/wiki/Release-Notes),  [source code](https://github.com/prjemian/spec2nexus)
 **citation** | [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.6264513.svg)](https://doi.org/10.5281/zenodo.6264513)
 **license** | [![Creative Commons Attribution 4.0 International Public License](https://anaconda.org/conda-forge/spec2nexus/badges/license.svg)](https://prjemian.github.io/spec2nexus/license.html)  [LICENSE.txt](https://prjemian.github.io/spec2nexus/license.html)
 **current releases** | [![image](https://img.shields.io/github/tag/prjemian/spec2nexus.svg)](https://github.com/prjemian/spec2nexus/tags)    [![image](https://img.shields.io/github/release/prjemian/spec2nexus.svg)](https://github.com/prjemian/spec2nexus/releases)

setup.py

@@ -2,19 +2,19 @@
 # -*- coding: utf-8 -*-
 
 from setuptools import setup
-import os
+import pathlib
 import sys
 
 import versioneer
 
 # pull in some definitions from the package's __init__.py file
-basedir = os.path.dirname(__file__)
-sys.path.insert(0, os.path.join(basedir, "src",))
+basedir = pathlib.Path(__file__).absolute().parent
+sys.path.insert(0, str(basedir / "src"))
 import spec2nexus as package
 
 
 verbose = 1
-long_description = open(os.path.join(basedir, "README.md"), "r").read()
+readme = open(str(basedir / "README.md"), "r").read()
 
 
 setup(
@@ -23,7 +23,8 @@
     cmdclass=versioneer.get_cmdclass(),
     license=package.__license__,
     description=package.__description__,
-    long_description=long_description,
+    long_description=readme,
+    long_description_content_type="md",
     author=package.__author_name__,
     author_email=package.__author_email__,
     url=package.__url__,