🔧 Remove deprecated needfilter directive (#1308)

This has been deprecated since v0.2.0, so high time to remove the code
useblocks · Oct 2, 2024 · ac4165c · ac4165c
1 parent bfdd575
commit ac4165c
Show file tree

Hide file tree

Showing 15 changed files with 20 additions and 346 deletions.
diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -179,7 +179,7 @@ And use it like:
 
          Some content
 
-      .. needfilter::
+      .. needlist::
          :filter: "filter_me" in another_option
 
    **Result**
@@ -192,7 +192,7 @@ And use it like:
 
       Some content
 
-   .. needfilter::
+   .. needlist::
       :filter: "filter_me" in another_option
 
 .. _needs_global_options:

diff --git a/docs/filter.rst b/docs/filter.rst
@@ -185,7 +185,7 @@ If it is invalid or returns False, the related need is not taken into account fo
          :tags: filter_example
          :hide:
 
-      .. needfilter::
+      .. needlist::
          :filter: "filter_example" in tags and (("B" in tags or ("spec" == type and "closed" == status)) or "test" == type)
 
 .. _filter_string_performance:

diff --git a/sphinx_needs/data.py b/sphinx_needs/data.py
@@ -559,19 +559,6 @@ class NeedsExtractType(NeedsFilteredBaseType):
     filter_arg: None | str
 
 
-class _NeedsFilterType(NeedsFilteredBaseType):
-    """Data to present (filtered) needs inside a list, table or diagram
-
-    .. deprecated:: 0.2.0
-    """
-
-    show_tags: bool
-    show_status: bool
-    show_filters: bool
-    show_legend: bool
-    layout: Literal["list", "table", "diagram"]
-
-
 class GraphvizStyleType(TypedDict, total=False):
     """Defines a graphviz style"""
 

diff --git a/sphinx_needs/directives/needfilter.py b/sphinx_needs/directives/needfilter.py
diff --git a/sphinx_needs/needs.py b/sphinx_needs/needs.py
@@ -46,11 +46,6 @@
     NeedextractDirective,
     process_needextract,
 )
-from sphinx_needs.directives.needfilter import (
-    Needfilter,
-    NeedfilterDirective,
-    process_needfilters,
-)
 from sphinx_needs.directives.needflow import (
     NeedflowDirective,
     NeedflowGraphiz,
@@ -126,7 +121,6 @@
 NODE_TYPES: _NODE_TYPES_T = {
     Needbar: process_needbar,
     # Needextract: process_needextract,
-    Needfilter: process_needfilters,
     Needlist: process_needlist,
     Needtable: process_needtables,
     NeedflowPlantuml: process_needflow_plantuml,
@@ -163,9 +157,6 @@ def setup(app: Sphinx) -> dict[str, Any]:
     app.add_node(
         Need, html=(html_visit, html_depart), latex=(latex_visit, latex_depart)
     )
-    app.add_node(
-        Needfilter,
-    )
     app.add_node(Needbar)
     app.add_node(Needimport)
     app.add_node(Needlist)
@@ -192,7 +183,6 @@ def setup(app: Sphinx) -> dict[str, Any]:
 
     # Define directives
     app.add_directive("needbar", NeedbarDirective)
-    app.add_directive("needfilter", NeedfilterDirective)
     app.add_directive("needlist", NeedlistDirective)
     app.add_directive("needtable", NeedtableDirective)
     app.add_directive("needflow", NeedflowDirective)