File tree Expand file tree Collapse file tree 1 file changed +35
-0
lines changed Expand file tree Collapse file tree 1 file changed +35
-0
lines changed Original file line number Diff line number Diff line change @@ -456,6 +456,41 @@ See :doc:`/build-customization` for more details.
456
456
:Default: ``{} ``
457
457
458
458
459
+ build.commands
460
+ ``````````````
461
+
462
+ Specify a list of commands that Read the Docs will run on the build process.
463
+ When ``build.commands `` is used, none of the :term: `pre-defined build jobs ` will be executed.
464
+ (see :doc: `/build-customization ` for more details).
465
+ This allows you to run custom commands and control the build process completely.
466
+ The ``output/ `` directory (relative to the checkout's path) will be uploaded and hosted by Read the Docs.
467
+
468
+ .. warning ::
469
+
470
+ This feature is in a *beta phase * and can suffer incompatible changes or even removed completely in the near feature.
471
+ Use it under your own responsibility.
472
+
473
+ .. code-block :: yaml
474
+
475
+ version : 2
476
+
477
+ build :
478
+ os : ubuntu-22.04
479
+ tools :
480
+ python : " 3.10"
481
+ commands :
482
+ - pip install pelican
483
+ - pelican --settings docs/pelicanconf.py --output output/ docs/
484
+
485
+ .. note ::
486
+
487
+ ``build.os `` and ``build.tools `` are also required when using ``build.commands ``.
488
+
489
+ :Type: ``list ``
490
+ :Required: ``false ``
491
+ :Default: ``[] ``
492
+
493
+
459
494
sphinx
460
495
~~~~~~
461
496
You can’t perform that action at this time.
0 commit comments