fix: exclude search files (#572)

Co-authored-by: pyansys-ci-bot <[email protected]>
Co-authored-by: Sébastien Morais <[email protected]>

Author: 3 people

doc/changelog.d/572.documentation.md

@@ -0,0 +1 @@
+fix: exclude search files

doc/source/user-guide/options.rst

@@ -124,6 +124,29 @@ the ``delay`` key in the ``static_search`` dictionary with a value specifying
 the amount of milliseconds to wait before executing the search. A value of
 ``0`` disables the debounce function.
 
+Additionally, you can decide the limit of the search results by setting the
+``limit`` key in the ``static_search`` dictionary. The default value is ``10``.
+
+To exclude files or directories from the search index, you can use the
+``files_to_exclude`` key in the ``static_search`` dictionary. This key is a list
+of strings representing the directories or files to exclude from the search
+index.
+
+Here is an example of how to add the ``static_search`` dictionary to the
+``html_theme_options`` dictionary:
+
+.. code-block:: python
+
+    html_theme_options = {
+        "static_search": {
+            "threshold": 0.5,
+            "limit": 10,
+            "minMatchCharLength": 1,
+            "delay": 300,
+            "files_to_exclude": ["_build", "api/", "examples/sphinx_demo"],
+        },
+    }
+
 To customise the indexing of your documentation, you can use the ``index_patterns`` dictionary in the ``conf.py`` file.
 This dictionary contains the paths to the directories you want to index and the type of nodes to index.
 The type of nodes can be ``ALL_NODES``, ``TITLES`` or ``PARAGRAPHS``.

src/ansys_sphinx_theme/search/fuse_search.py

@@ -204,7 +204,21 @@ def create_search_index(app, exception):
 
     search_index_list = []
 
-    for document in app.env.found_docs:
+    static_search_options = app.config.html_theme_options.get("static_search", {})
+    excluded_docs = static_search_options.get("files_to_exclude", [])
+    included_docs = app.env.found_docs
+
+    for exclude_doc in excluded_docs:
+        exclude_doc = Path(exclude_doc).resolve()
+
+        # Exclude documents based on whether exclude_doc is a folder or a file:
+        # - For folders, exclude all documents within the folder.
+        # - For files, exclude only the exact file match.
+        included_docs = [
+            doc for doc in included_docs if not Path(doc).resolve().is_relative_to(exclude_doc)
+        ]
+
+    for document in included_docs:
         pattern = get_pattern_for_each_page(app, document)
         search_index = SearchIndex(document, app, pattern)
         search_index.build_sections()