fix: raise exception for deprecated index pattern (#729)

Co-authored-by: pyansys-ci-bot <[email protected]>
Co-authored-by: Roberto Pastor Muela <[email protected]>

Author: 3 people

doc/changelog.d/729.fixed.md

@@ -0,0 +1 @@
+Raise exception for deprecated index pattern

src/ansys_sphinx_theme/search/__init__.py

@@ -40,9 +40,12 @@ def update_search_config(app: Sphinx) -> None:
     theme_static_options["keys"] = ["title", "text", "objectID"]
     theme_static_options["threshold"] = theme_static_options.get("threshold", 0.2)
     theme_static_options["limit"] = theme_static_options.get("limit", 10)
-    app.add_config_value("index_patterns", {}, "html")
     app.config.html_theme_options["static_search"] = theme_static_options
 
+    # TODO (RV): Deprecate this in release 0.16.0
+    # https://github.com/ansys/ansys-sphinx-theme/issues/730
+    app.add_config_value("index_patterns", {}, "html")
+
 
 __all__ = [
     "create_search_index",

src/ansys_sphinx_theme/search/fuse_search.py

@@ -194,24 +194,16 @@ def create_search_index(app, exception):
     included_docs = app.env.found_docs
     filter_options = app.config.html_theme_options.get("search_filters", {})
 
+    # TODO (RV): Deprecate this in release 0.16.0
+    # https://github.com/ansys/ansys-sphinx-theme/issues/730
     patterns = app.env.config.index_patterns or {}
     if patterns:
-        logger.error(
-            "The 'index_patterns' is depreciated and no longer supported. "
+        raise TypeError(
+            "The 'index_patterns' is deprecated and no longer supported. "
             "Please see the documentation https://sphinxdocs.ansys.com for the "
             "new search configuration options."
         )
 
-    patterns = app.env.config.index_patterns or {}
-    if patterns:
-        # Raise warning that this feature will deprecate in the future
-        logger.warning(
-            "The 'index_patterns' configuration option is deprecated and will be removed"
-            " in v1.5.0 onwards. "
-            "It will index all paragraphs, titles, and literals by default. "
-            "More information can be found in the documentation at https://sphinxdocs.ansys.com.",
-        )
-
     for exclude_doc in excluded_docs:
         exclude_doc = Path(exclude_doc).resolve()