From 034b3d7d272887024cca7536f57b26d9647c64d8 Mon Sep 17 00:00:00 2001 From: Erik Sundell Date: Wed, 11 Oct 2023 15:10:17 +0200 Subject: [PATCH] nox: add docstring about nox and list command how to use it --- noxfile.py | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/noxfile.py b/noxfile.py index 0c659213b2..d8c5d41a0c 100644 --- a/noxfile.py +++ b/noxfile.py @@ -1,3 +1,14 @@ +""" +noxfile.py is a configuration file for the command-line tool nox that automates +tasks in multiple Python environments. We use it to setup an environment to +build our documentation. + +Config reference: https://nox.thea.codes/en/stable/config.html#noxfile + +Common tasks: +- Install nox: pip install nox +- Start a live reloading docs server: nox -- live +""" import nox nox.options.reuse_existing_virtualenvs = True