@@ -12,6 +12,8 @@ and also how to override the build process completely:
12
12
`Override the build process `_
13
13
If you want full control over your build. This option supports any tool that generates HTML as part of the build.
14
14
15
+ .. contents :: Table of contents
16
+ :local:
15
17
16
18
Extend the build process
17
19
------------------------
@@ -245,7 +247,7 @@ Override the build process
245
247
.. warning ::
246
248
247
249
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.
249
251
However, we do plan to support these features in the future.
250
252
Use this feature at your own risk.
251
253
@@ -273,3 +275,18 @@ your project could use the following configuration file:
273
275
As Read the Docs does not have control over the build process,
274
276
you are responsible for running all the commands required to install requirements and build the documentation properly.
275
277
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