Skip to content

Commit 75ea963

Browse files
authored
doc: Document build.commands working directory (#11218)
I just got bit by this trying to do ```yaml build: commands: - cd docs - myst build --html ``` After the `cd docs`, the next command is reset to the main repo root <!-- readthedocs-preview docs start --> --- :books: Documentation previews :books: - User's documentation (`docs`): https://docs--11218.org.readthedocs.build/en/11218/ <!-- readthedocs-preview docs end --> <!-- readthedocs-preview dev start --> - Developer's documentation (`dev`): https://dev--11218.org.readthedocs.build/en/11218/ <!-- readthedocs-preview dev end -->
1 parent fa864ff commit 75ea963

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/user/config-file/v2.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -557,6 +557,11 @@ See :doc:`/build-customization` for more details.
557557

558558
``build.os`` and ``build.tools`` are also required when using ``build.commands``.
559559

560+
.. note::
561+
562+
All items in the ``build.commands`` array are executed in a clean shell environment, i.e. environment changes do not
563+
persist and the working directory always start from the git repo.
564+
560565
:Type: ``list``
561566
:Required: ``false``
562567
:Default: ``[]``

0 commit comments

Comments
 (0)