Skip to content

Commit

Permalink
Build: remove "beta" from build.commands (#11411)
Browse files Browse the repository at this point in the history
* Build: remove "beta" from `build.commands`

Closes #11405

* Apply suggestions from code review

Co-authored-by: Eric Holscher <[email protected]>

* Apply suggestions from code review

---------

Co-authored-by: Eric Holscher <[email protected]>
  • Loading branch information
humitos and ericholscher authored Jun 17, 2024
1 parent 8d91add commit 1ad7a38
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 13 deletions.
9 changes: 5 additions & 4 deletions docs/user/build-customization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <rtd-blog:addons-flyout-menu-beta>`
on projects using ``build.commands`` configuration key.
We are using :ref:`our new addons integration <rtd-blog:addons-flyout-menu-beta>`
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 <build-customization:extend the build process>` is not enough,
Expand Down
10 changes: 5 additions & 5 deletions docs/user/config-file/v2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <rtd-blog:addons-flyout-menu-beta>`_
on projects using ``build.commands`` configuration key.
Use it under your own responsibility.
We are using :ref:`our new addons integration <rtd-blog:addons-flyout-menu-beta>`
on projects using ``build.commands``.
This will become the default soon,
but has some slight differences from our previous flyout.

.. code-block:: yaml
Expand Down
4 changes: 0 additions & 4 deletions readthedocs/doc_builder/director.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"},
Expand Down

0 comments on commit 1ad7a38

Please sign in to comment.