From 1ad7a38b163b916b929791d87746eaf6995ab371 Mon Sep 17 00:00:00 2001 From: Manuel Kaufmann Date: Mon, 17 Jun 2024 10:54:56 +0200 Subject: [PATCH] Build: remove "beta" from `build.commands` (#11411) * Build: remove "beta" from `build.commands` Closes #11405 * Apply suggestions from code review Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com> * Apply suggestions from code review --------- Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com> --- docs/user/build-customization.rst | 9 +++++---- docs/user/config-file/v2.rst | 10 +++++----- readthedocs/doc_builder/director.py | 4 ---- 3 files changed, 10 insertions(+), 13 deletions(-) diff --git a/docs/user/build-customization.rst b/docs/user/build-customization.rst index d82a3cc9f8f..d2907e34036 100644 --- a/docs/user/build-customization.rst +++ b/docs/user/build-customization.rst @@ -414,11 +414,12 @@ Take a look at the following example: Override the build process -------------------------- -.. warning:: +.. note:: - This feature is in *beta* and could change without warning. - We are currently testing :ref:`the new addons integrations we are building ` - on projects using ``build.commands`` configuration key. + We are using :ref:`our new addons integration ` + on projects using ``build.commands``. + This will become the default soon, + but has some slight differences from our previous flyout. If your project requires full control of the build process, and :ref:`extending the build process ` is not enough, diff --git a/docs/user/config-file/v2.rst b/docs/user/config-file/v2.rst index a77a297e77c..0fb0169715c 100644 --- a/docs/user/config-file/v2.rst +++ b/docs/user/config-file/v2.rst @@ -468,12 +468,12 @@ When ``build.commands`` is used, none of the :term:`pre-defined build jobs` will This allows you to run custom commands and control the build process completely. The ``$READTHEDOCS_OUTPUT/html`` directory will be uploaded and hosted by Read the Docs. -.. warning:: +.. note:: - This feature is in a *beta phase* and could suffer incompatible changes or even removed completely in the near feature. - We are currently testing `the new addons integrations we are building `_ - on projects using ``build.commands`` configuration key. - Use it under your own responsibility. + We are using :ref:`our new addons integration ` + on projects using ``build.commands``. + This will become the default soon, + but has some slight differences from our previous flyout. .. code-block:: yaml diff --git a/readthedocs/doc_builder/director.py b/readthedocs/doc_builder/director.py index a22203056d0..6fdd8202b60 100644 --- a/readthedocs/doc_builder/director.py +++ b/readthedocs/doc_builder/director.py @@ -418,10 +418,6 @@ def check_old_output_directory(self): def run_build_commands(self): """Runs each build command in the build environment.""" - self.attach_notification( - message_id=BuildUserError.BUILD_COMMANDS_IN_BETA, - ) - reshim_commands = ( {"pip", "install"}, {"conda", "create"},