🔧 Remove use of deprecated needs_extra_options as dict (#1126)

useblocks · Feb 23, 2024 · 3719cbd · 3719cbd
1 parent 9c8c721
commit 3719cbd
Show file tree

Hide file tree

Showing 10 changed files with 21 additions and 54 deletions.
diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -165,12 +165,7 @@ And use it like:
 
    .. code-block:: python
 
-      from docutils.parsers.rst import directives
-
-      needs_extra_options = {
-         "my_extra_option": directives.unchanged,
-         "another_option": directives.unchanged,
-         }
+      needs_extra_options = ["my_extra_option",  "another_option"]
 
    **index.rst**
 

diff --git a/docs/layout_styles.rst b/docs/layout_styles.rst
@@ -307,16 +307,15 @@ The line for the ``side`` area could look like::
 
    The used layout takes the value from ``author`` and puts some image-path related information around it.
 
-Here is the complete used code::
+Here is the complete used code
+
+.. code-block:: python
 
    # conf.py
    # -------
 
-   from docutils.parsers.rst import directives
    # Make the author option valid
-   needs_extra_options = {
-         "author": directives.unchanged,
-         }
+   needs_extra_options = ["author"]
 
    # Define own layout
    needs_layouts = {
@@ -331,8 +330,10 @@ Here is the complete used code::
        }
    }
 
-   # rst-code of the above need
-   # --------------------------
+.. code-block:: restructuredtext
+
+   rst-code of the above need
+   --------------------------
 
    .. spec:: My test spec
       :author: daniel

diff --git a/tests/doc_test/add_sections/conf.py b/tests/doc_test/add_sections/conf.py
@@ -1,12 +1,10 @@
-from docutils.parsers.rst import directives
-
 extensions = ["sphinx_needs"]
 
-needs_extra_options = {
-    "introduced": directives.unchanged,
-    "updated": directives.unchanged,
-    "impacts": directives.unchanged,
-}
+needs_extra_options = [
+    "introduced",
+    "updated",
+    "impacts",
+]
 
 needs_template_collapse = """
 .. _{{id}}:

diff --git a/tests/doc_test/doc_df_calc_sum/conf.py b/tests/doc_test/doc_df_calc_sum/conf.py
@@ -1,5 +1,3 @@
-from docutils.parsers.rst import directives
-
 extensions = ["sphinx_needs"]
 
 needs_types = [
@@ -33,8 +31,4 @@
     },
 ]
 
-needs_extra_options = {
-    "test_func": directives.unchanged,
-    "hours": directives.unchanged,
-    "amount": directives.unchanged,
-}
+needs_extra_options = ["test_func", "hours", "amount"]
diff --git a/tests/doc_test/doc_df_check_linked_values/conf.py b/tests/doc_test/doc_df_check_linked_values/conf.py
@@ -1,5 +1,3 @@
-from docutils.parsers.rst import directives
-
 extensions = ["sphinx_needs"]
 
 needs_types = [
@@ -33,4 +31,4 @@
     },
 ]
 
-needs_extra_options = {"test_func": directives.unchanged, "hours": directives.unchanged}
+needs_extra_options = ["test_func", "hours"]
diff --git a/tests/doc_test/doc_df_user_functions/conf.py b/tests/doc_test/doc_df_user_functions/conf.py
@@ -1,5 +1,3 @@
-from docutils.parsers.rst import directives
-
 extensions = ["sphinx_needs"]
 
 needs_types = [
@@ -33,7 +31,7 @@
     },
 ]
 
-needs_extra_options = {"test_func": directives.unchanged, "hours": directives.unchanged}
+needs_extra_options = ["test_func", "hours"]
 
 
 def my_own_function(app, need, needs):

diff --git a/tests/doc_test/doc_dynamic_functions/conf.py b/tests/doc_test/doc_dynamic_functions/conf.py
@@ -1,5 +1,3 @@
-from docutils.parsers.rst import directives
-
 extensions = ["sphinx_needs"]
 
 needs_types = [
@@ -33,4 +31,4 @@
     },
 ]
 
-needs_extra_options = {"test_func": directives.unchanged}
+needs_extra_options = ["test_func"]
diff --git a/tests/doc_test/doc_layout/conf.py b/tests/doc_test/doc_layout/conf.py
@@ -1,5 +1,3 @@
-from docutils.parsers.rst import directives
-
 extensions = ["sphinx_needs"]
 
 needs_types = [
@@ -33,10 +31,7 @@
     },
 ]
 
-needs_extra_options = {
-    "author": directives.unchanged,
-}
-
+needs_extra_options = ["author"]
 
 needs_layouts = {
     "example": {

diff --git a/tests/doc_test/doc_needs_filter_data/conf.py b/tests/doc_test/doc_needs_filter_data/conf.py
@@ -1,8 +1,6 @@
 import os
 import sys
 
-from docutils.parsers.rst import directives
-
 sys.path.insert(0, os.path.abspath("./"))
 
 extensions = ["sphinx_needs", "sphinxcontrib.plantuml"]
@@ -49,9 +47,7 @@ def custom_func():
 
 needs_filter_data = {"current_variant": "project_x", "sphinx_tag": custom_func()}
 
-needs_extra_options = {
-    "variant": directives.unchanged,
-}
+needs_extra_options = ["variant"]
 
 needs_warnings = {
     "variant_not_equal_current_variant": "variant != current_variant",

diff --git a/tests/doc_test/extra_options/conf.py b/tests/doc_test/extra_options/conf.py
@@ -1,12 +1,6 @@
-from docutils.parsers.rst import directives
-
 extensions = ["sphinx_needs"]
 
-needs_extra_options = {
-    "introduced": directives.unchanged,
-    "updated": directives.unchanged,
-    "impacts": directives.unchanged,
-}
+needs_extra_options = ["introduced", "updated", "impacts"]
 
 
 def setup(app):