Skip to content

Commit

Permalink
minor tweaks from getting started
Browse files Browse the repository at this point in the history
  • Loading branch information
bjchambers committed Oct 9, 2023
1 parent c81c3a0 commit 3245f8b
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
3 changes: 1 addition & 2 deletions python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -71,4 +71,3 @@ nox
```

This is primarily used in CI.

8 changes: 8 additions & 0 deletions python/noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"):
Expand All @@ -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"):
Expand Down

0 comments on commit 3245f8b

Please sign in to comment.