From 3245f8b0e4a00005fd71ab0fb422b37f13e56095 Mon Sep 17 00:00:00 2001 From: Ben Chambers <35960+bjchambers@users.noreply.github.com> Date: Mon, 9 Oct 2023 11:21:57 -0700 Subject: [PATCH] minor tweaks from getting started --- python/README.md | 3 +-- python/noxfile.py | 8 ++++++++ 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/python/README.md b/python/README.md index 3b7fa10c1..bb2b2b59f 100644 --- a/python/README.md +++ b/python/README.md @@ -44,7 +44,7 @@ nox * Generate reference docs ```shell - nox -s gen-docs + nox -s docs-gen ``` You should re-run this after making any updates to the `pysrc` docstrings. @@ -71,4 +71,3 @@ nox ``` This is primarily used in CI. - \ No newline at end of file diff --git a/python/noxfile.py b/python/noxfile.py index 82fb8b191..50e8c8577 100644 --- a/python/noxfile.py +++ b/python/noxfile.py @@ -140,6 +140,10 @@ def docs_gen(session: nox.Session) -> None: @nox.session(python=python_versions[0]) def docs(session: nox.Session) -> None: """Build and serve the documentation with live reloading on file changes.""" + if not shutil.which("quarto"): + session.error("Unable to execute `quarto`. Is it installed and in your path?\n" + "See https://quarto.org/docs/get-started/") + install(session, groups=["docs"]) with session.chdir("docs"): @@ -149,6 +153,10 @@ def docs(session: nox.Session) -> None: @nox.session(name="docs-build", python=python_versions[0]) def docs_build(session: nox.Session) -> None: """Build the docs.""" + if not shutil.which("quarto"): + session.error("Unable to execute `quarto`. Is it installed and in your path?\n" + "See https://quarto.org/docs/get-started/") + install(session, groups=["docs"]) with session.chdir("docs"):