Skip to content

Commit a5052de

Browse files
authored
Docs: update build.commands note (readthedocs#10708)
* Docs: update `build.commands` note This not mentions we are testing the new addons integration. * Update note on `build.commands` config key docs as well
1 parent bf88ce6 commit a5052de

File tree

2 files changed

+6
-7
lines changed

2 files changed

+6
-7
lines changed

docs/user/build-customization.rst

+2-3
Original file line numberDiff line numberDiff line change
@@ -373,9 +373,8 @@ Override the build process
373373
.. warning::
374374

375375
This feature is in *beta* and could change without warning.
376-
It does not yet support some of the Read the Docs' features like the :term:`flyout menu`.
377-
We do our best to not break existing configurations,
378-
but use this feature at your own risk.
376+
We are currently testing `the new addons integrations we are building <rtd-blog:addons-flyout-menu-beta>`_
377+
on projects using ``build.commands`` configuration key.
379378

380379
If your project requires full control of the build process,
381380
and :ref:`extending the build process <build-customization:extend the build process>` is not enough,

docs/user/config-file/v2.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -438,13 +438,13 @@ Specify a list of commands that Read the Docs will run on the build process.
438438
When ``build.commands`` is used, none of the :term:`pre-defined build jobs` will be executed.
439439
(see :doc:`/build-customization` for more details).
440440
This allows you to run custom commands and control the build process completely.
441-
The ``_readthedocs/html`` directory (relative to the checkout's path) will be uploaded and hosted by Read the Docs.
441+
The ``$READTHEDOCS_OUTPUT/html`` directory will be uploaded and hosted by Read the Docs.
442442

443443
.. warning::
444444

445445
This feature is in a *beta phase* and could suffer incompatible changes or even removed completely in the near feature.
446-
It does not yet support some of the Read the Docs' integrations like the :term:`flyout menu`, search and ads.
447-
However, integrating all of them is part of the plan.
446+
We are currently testing `the new addons integrations we are building <rtd-blog:addons-flyout-menu-beta>`_
447+
on projects using ``build.commands`` configuration key.
448448
Use it under your own responsibility.
449449

450450
.. code-block:: yaml
@@ -457,7 +457,7 @@ The ``_readthedocs/html`` directory (relative to the checkout's path) will be up
457457
python: "3.11"
458458
commands:
459459
- pip install pelican
460-
- pelican --settings docs/pelicanconf.py --output _readthedocs/html/ docs/
460+
- pelican --settings docs/pelicanconf.py --output $READTHEDOCS_OUTPUT/html/ docs/
461461
462462
.. note::
463463

0 commit comments

Comments
 (0)