From 8abae4e2ac409b6ae6b1fe5fddc4265806833b12 Mon Sep 17 00:00:00 2001 From: "Philipp A." Date: Mon, 2 Sep 2024 14:19:35 +0200 Subject: [PATCH] open docs --- {{cookiecutter.project_name}}/docs/contributing.md | 1 + {{cookiecutter.project_name}}/pyproject.toml | 1 + 2 files changed, 2 insertions(+) diff --git a/{{cookiecutter.project_name}}/docs/contributing.md b/{{cookiecutter.project_name}}/docs/contributing.md index 07e21844..b28a8b56 100644 --- 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 ``` diff --git a/{{cookiecutter.project_name}}/pyproject.toml b/{{cookiecutter.project_name}}/pyproject.toml index 60afc22d..2eb0f84a 100644 --- 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]