Merge pull request #21 from datalad/contributing

Contributing

.gitignore

@@ -1,2 +1,5 @@
 dist/
 .coverage
+docs/generated
+docs/_build
+*.swp

CONTRIBUTING.md

@@ -17,6 +17,20 @@ Here are a few pointers. For full detail, see the hatch docs.
 hatch test [--cover]
 ```
 
+### Build the HTML documentation (under `docs/_build/html`)
+
+```
+hatch run docs:build
+# clean with
+hatch run docs:clean
+```
+
+### Check type annotations
+
+```
+hatch run types:check
+```
+
 ### Check the `datasalad` version
 
 `hatch` determines the version from the VCS tags. This can help check that

pyproject.toml

@@ -59,7 +59,23 @@ extra-dependencies = [
   "argcomplete",
 ]
 [tool.hatch.envs.types.scripts]
-check = "mypy --install-types --non-interactive {args:src/datasalad tests}"
+check = [
+  "mypy --install-types --non-interactive --python-version 3.8 --pretty --show-error-context datasalad",
+]
+
+[tool.hatch.envs.docs]
+extra-dependencies = [
+  "sphinx",
+]
+[tool.hatch.envs.docs.scripts]
+build = [
+  "make -C docs html",
+]
+clean = [
+  "rm -rf docs/generated",
+  "make -C docs clean",
+]
+
 
 [tool.coverage.run]
 source_pkgs = ["datasalad", "tests"]