From 432557fdc8b640dd1d18cd5d22c5bc7b8b0b0a0d Mon Sep 17 00:00:00 2001 From: Raniere Gaia Costa da Silva Date: Wed, 22 Oct 2025 11:54:04 +0200 Subject: [PATCH] Import noxfile.py from team-compass --- noxfile.py | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 noxfile.py diff --git a/noxfile.py b/noxfile.py new file mode 100644 index 000000000..206e48197 --- /dev/null +++ b/noxfile.py @@ -0,0 +1,38 @@ +import os.path + +import nox + +nox.options.reuse_existing_virtualenvs = True + + +@nox.session(default=False) +def docs(session): + """ + Build the documentation and, optionally with '-- live', run a web server. + """ + docs_dir = "docs" + source_dir = os.path.join(docs_dir, "source") # where conf.py is located + data_dir = os.path.join(source_dir, "_data") + output_dir = os.path.join(docs_dir, "_build") + + session.install("-r", os.path.join(docs_dir, "requirements.txt")) + + doc_build_default_args = ["-b", "dirhtml", source_dir, output_dir] + + if "live" in session.posargs: + # For live preview, sphinx-autobuild is used. + # To avoid sphinx-autobuild be missing, + # sphinx-autobuild is installed explicitly. + session.install("sphinx-autobuild") + cmd = ["sphinx-autobuild"] + + # Add relative paths to this if we ever need to ignore them + autobuild_ignore = [output_dir, os.path.join(data_dir, "generated")] + + for folder in autobuild_ignore: + cmd.extend(["--ignore", f"*/{folder}/*"]) + + cmd.extend(doc_build_default_args) + session.run(*cmd) + else: + session.run("sphinx-build", *doc_build_default_args)