Document build.commands shell environment

readthedocs · Mar 15, 2024 · 7a1136f · 7a1136f
1 parent a0526ff
commit 7a1136f
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/docs/user/config-file/v2.rst b/docs/user/config-file/v2.rst
@@ -487,6 +487,11 @@ The ``$READTHEDOCS_OUTPUT/html`` directory will be uploaded and hosted by Read t
 
    ``build.os`` and ``build.tools`` are also required when using ``build.commands``.
 
+.. note::
+
+   All items in the ``build.commands`` array are executed in a clean shell environment, i.e. environment changes do not
+   persist and the working directory always start from the git repo.
+
 :Type: ``list``
 :Required: ``false``
 :Default: ``[]``