Fix README, add README linting step

msmdev · Jan 29, 2021 · b06b881 · b06b881
1 parent 4fac09f
commit b06b881
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -55,7 +55,7 @@ jobs:
 
         -   name: Linting
             run: |
-                tox -e lint
+                tox -e lint,readme
         -   name: Documentation check
             run: |
                 echo "Uncomment me below once the badges are working..."

diff --git a/setup.py b/setup.py
@@ -18,8 +18,8 @@
     author_email=__email__,
     maintainer=__maintainer__,
     maintainer_email=__email__,
-    description=Path("README.rst").read_text("utf-8").splitlines()[2],
-    long_description=Path("README.rst").read_text("utf-8"),
+    description=Path("README.rst").read_text("utf-8").splitlines()[34],
+    long_description="\n".join(Path("README.rst").read_text("utf-8").splitlines()[:-4]).replace("|br|", r"\\"),
     long_description_content_type="text/x-rst; charset=UTF-8",
     url="https://github.com/msmdev/pygpcca",
     download_url="https://pypi.org/project/pygpcca/",