From 7a1136f762b3bac9a030b255dff748362143e150 Mon Sep 17 00:00:00 2001 From: Cristian Le Date: Thu, 14 Mar 2024 14:35:59 +0100 Subject: [PATCH] Document `build.commands` shell environment --- docs/user/config-file/v2.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/user/config-file/v2.rst b/docs/user/config-file/v2.rst index 89443c49271..374556e0d48 100644 --- 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: ``[]``