Skip to content

Commit defc159

Browse files
committed
Update docs
1 parent 27b62f5 commit defc159

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

docs/user/build-customization.rst

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ and also how to override the build process completely:
1212
`Override the build process`_
1313
If you want full control over your build. This option supports any tool that generates HTML as part of the build.
1414

15+
.. contents:: Table of contents
16+
:local:
1517

1618
Extend the build process
1719
------------------------
@@ -245,7 +247,7 @@ Override the build process
245247
.. warning::
246248

247249
This feature is in a *beta phase* and could suffer incompatible changes or even removed completely in the near feature.
248-
It does not yet support some of the Read the Docs' features like the :term:`flyout menu`, search and ads.
250+
It does not yet support some of the Read the Docs' features like the :term:`flyout menu`, and ads.
249251
However, we do plan to support these features in the future.
250252
Use this feature at your own risk.
251253

@@ -273,3 +275,18 @@ your project could use the following configuration file:
273275
As Read the Docs does not have control over the build process,
274276
you are responsible for running all the commands required to install requirements and build the documentation properly.
275277
Once the build process finishes, the ``_readthedocs/html/`` folder will be hosted.
278+
279+
Search support
280+
++++++++++++++
281+
282+
Read the Docs will automatically index the content of all your HTML files,
283+
respecting the :ref:`search <config-file/v2:search>` options from your config file.
284+
285+
You can access the search results from the :guilabel:`Search` tab of your project,
286+
or by using the :ref:`search API <server-side-search:api>`.
287+
288+
.. note::
289+
290+
In order for Read the Docs to index your HTML files correctly,
291+
they should follow some of the conventions described
292+
at :doc:`rtd-dev:search-integration`.

0 commit comments

Comments
 (0)