prepare for release (#9)

keewis · web-flow · commit 23a6fe27ad02 · 2022-03-30T12:05:38.000+02:00
* add the readme as the long description

* pin `click`

* install from within the requirements.txt
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -8,8 +8,6 @@ build:
 python:
   install:
     - requirements: docs/requirements.txt
-    - method: pip
-      path: .
 
 sphinx:
   fail_on_warning: true
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -2,6 +2,7 @@ dask-jobqueue
 dask[array]
 distributed
 typer
+click<8.1  # 8.1 breaks typer at the moment
 rich
 pyyaml
 ipython
@@ -10,3 +11,4 @@ sphinx-copybutton
 sphinx-panels
 sphinx-click
 sphinx-book-theme
+-e .
diff --git a/setup.cfg b/setup.cfg
@@ -3,6 +3,8 @@ name = dask-hpcconfig
 author_email = justus.magin@ifremer.fr
 license = MIT
 description = Configuration for various dask clusters
+long_description=file: README.md
+long_description_content_type=text/markdown
 url = https://github.com/umr-lops/dask-hpcconfig
 project_urls =
     Documentation=https://dask-hpcconfig.readthedocs.io
