Skip to content

Docs: update build.commands note #10708

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 8, 2023
Merged

Docs: update build.commands note #10708

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c5f2d89
Docs: update `build.commands` note
humitos Sep 5, 2023
e302294
Update note on `build.commands` config key docs as well
humitos Sep 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions docs/user/build-customization.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,9 +373,8 @@ Override the build process
.. warning::

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

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
8 changes: 4 additions & 4 deletions docs/user/config-file/v2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -438,13 +438,13 @@ Specify a list of commands that Read the Docs will run on the build process.
When ``build.commands`` is used, none of the :term:`pre-defined build jobs` will be executed.
(see :doc:`/build-customization` for more details).
This allows you to run custom commands and control the build process completely.
The ``_readthedocs/html`` directory (relative to the checkout's path) will be uploaded and hosted by Read the Docs.
The ``$READTHEDOCS_OUTPUT/html`` directory will be uploaded and hosted by Read the Docs.

.. warning::

This feature is in a *beta phase* and could suffer incompatible changes or even removed completely in the near feature.
It does not yet support some of the Read the Docs' integrations like the :term:`flyout menu`, search and ads.
However, integrating all of them is part of the plan.
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.

.. code-block:: yaml
Expand All @@ -457,7 +457,7 @@ The ``_readthedocs/html`` directory (relative to the checkout's path) will be up
python: "3.11"
commands:
- pip install pelican
- pelican --settings docs/pelicanconf.py --output _readthedocs/html/ docs/
- pelican --settings docs/pelicanconf.py --output $READTHEDOCS_OUTPUT/html/ docs/

.. note::

Expand Down