adds docs env and script

Duke-GCB · Sep 2, 2024 · b7fd240 · b7fd240
1 parent 8f2e312
commit b7fd240
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -98,4 +98,10 @@ hatch run test:cov
 
 ```
 hatch run calrissian
+```
+
+### Serve the documentation
+
+```
+hatch run docs:serve
 ```
diff --git a/pyproject.toml b/pyproject.toml
@@ -106,10 +106,22 @@ dependencies = [
 [tool.hatch.envs.test.env-vars]
 RETRY_ATTEMPTS="0"
 
-[tool.hatch.envs.default.scripts]
+[tool.hatch.envs.test.scripts]
 test = "hatch run nose2"
 testv = "hatch run nose2 --verbose"
 cov = ["coverage run --source=calrissian -m nose2", "coverage report"]
 
 [[tool.hatch.envs.test.matrix]]
-python = ["3.8", "3.9", "3.10", "3.11", "3.12"]
+python = ["3.8", "3.9", "3.10", "3.11", "3.12"]
+
+[tool.hatch.envs.docs]
+skip-install = false
+
+dependencies = [
+  "pdocs",
+  "mkdocs-material",
+  "mkdocs-jupyter"
+]
+
+[tool.hatch.envs.docs.scripts]
+serve = "mkdocs serve"