Merge pull request #3254 from consideRatio/pr/nox-info

nox: add docstring about nox and list command how to use it
2i2c-org · Oct 12, 2023 · 88e9d14 · 88e9d14
2 parents dcf1cf3 + 034b3d7
commit 88e9d14
Showing 1 changed file with 11 additions and 0 deletions.
diff --git 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