DEV: add task to open locally-built docs

lucascolley · lucascolley · commit 6e596d9c8197 · 2024-09-25T12:54:20.000+01:00
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -44,6 +44,12 @@ pixi run test
 pixi run docs
 ```
 
+- To open and preview the locally-built docs:
+
+```
+pixi run open-docs
+```
+
 - To install a [pre-commit](https://pre-commit.com) hook and run the lint suite:
 
 ```
diff --git a/pixi.lock b/pixi.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -100,6 +100,7 @@ sphinx_autodoc_typehints = "*"
 
 [tool.pixi.feature.docs.tasks]
 docs = { cmd = ["sphinx-build", ".", "build/"], cwd = "docs" }
+open-docs = { cmd = ["open", "build/index.html"], cwd = "docs" }
 
 [tool.pixi.feature.dev.dependencies]
 ipython = "*"
