open docs

scverse · Sep 2, 2024 · 8abae4e · 8abae4e
1 parent bcfd370
commit 8abae4e
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/{{cookiecutter.project_name}}/docs/contributing.md b/{{cookiecutter.project_name}}/docs/contributing.md
@@ -147,6 +147,7 @@ repository.
 
 ```bash
 hatch docs:build
+hatch docs:open
 ```
 
 <!-- Links -->

diff --git a/{{cookiecutter.project_name}}/pyproject.toml b/{{cookiecutter.project_name}}/pyproject.toml
@@ -67,6 +67,7 @@ features = [ "dev" ]
 [tool.hatch.envs.docs]
 extra-features = [ "doc" ]
 scripts.build = "sphinx-build -M html docs docs/_build {args}"
+scripts.open = "python -m webbrowser -t docs/_build/html/index.html"
 scripts.clean = "git clean -fdX -- {args:docs}"
 
 [tool.hatch.envs.hatch-test]
-Original file line number
+Diff line change
@@ Expand Up / @@ -147,6 +147,7 @@ repository. @@
     ```bash
     hatch docs:build
+    hatch docs:open
     ```
     <!-- Links -->
@@ Expand Down @@