Merge branch 'skeleton'

Author: coretl

.github/workflows/docs.yml

@@ -28,6 +28,9 @@ jobs:
         with:
           pipenv-run: docs
 
+      - name: Check links resolve
+        run: pipenv run docs -b linkcheck
+
       - name: Move to versioned directory
         # e.g. master or 0.1.2
         run: mv build/html ".github/pages/${GITHUB_REF##*/}"

CONTRIBUTING.rst

@@ -45,8 +45,8 @@ commit`` on just the files that have changed::
     $ pipenv run pre-commit install
 
 .. _black: https://github.com/psf/black
-.. _flake8: http://flake8.pycqa.org/en/latest/
-.. _isort: https://github.com/timothycrosley/isort
+.. _flake8: https://flake8.pycqa.org/en/latest/
+.. _isort: https://github.com/PyCQA/isort
 .. _mypy: https://github.com/python/mypy
 .. _pre-commit: https://pre-commit.com/
 
@@ -104,7 +104,7 @@ When this happens:
 - Push to internal gitlab and do a dls-release.py of the tag
 - Check and edit for clarity the autogenerated GitHub release_
 
-.. _release: https://dls-controls.github.io/dls-python3-skeleton/releases
+.. _release: https://github.com/dls-controls/dls-python3-skeleton/releases
 
 Apart from this, ``master`` and ``skeleton`` should always be deployable,
 and are considered the latest release.

setup.cfg

@@ -17,8 +17,11 @@ classifiers =
 [options]
 python_requires = >=3.7
 packages = find:
+# =src is interpreted as {"": "src"}
+# as per recommendation here https://hynek.me/articles/testing-packaging/
 package_dir =
     =src
+    
 # Specify any package dependencies below.
 # install_requires =
 #     numpy