diff --git a/sphinx_needs/data.py b/sphinx_needs/data.py index 2cbc74d92..18090ac0b 100644 --- a/sphinx_needs/data.py +++ b/sphinx_needs/data.py @@ -126,6 +126,7 @@ class CoreFieldParameters(TypedDict): "schema": {"type": "boolean", "default": False}, "exclude_external": True, "exclude_import": True, + "exclude_json": True, }, "layout": { "description": "Key of the layout, which is used to render the need.", diff --git a/sphinx_needs/needs.py b/sphinx_needs/needs.py index 17a8cc7a5..cdfb524bc 100644 --- a/sphinx_needs/needs.py +++ b/sphinx_needs/needs.py @@ -541,7 +541,7 @@ def load_config(app: Sphinx, *_args: Any) -> None: if needs_config.report_dead_links is not True: log_warning( LOGGER, - 'Config option "needs_constraints_failed_color" is deprecated. Please use `suppress_warnings = ["needs.link_outgoing"]` instead.', + 'Config option "needs_report_dead_links" is deprecated. Please use `suppress_warnings = ["needs.link_outgoing"]` instead.', "config", None, ) diff --git a/tests/__snapshots__/test_basic_doc.ambr b/tests/__snapshots__/test_basic_doc.ambr index 67cdaa33b..cc30f060d 100644 --- a/tests/__snapshots__/test_basic_doc.ambr +++ b/tests/__snapshots__/test_basic_doc.ambr @@ -18,7 +18,6 @@ }), 'content': '', 'created_at': '', - 'delete': False, 'docname': 'index', 'doctype': '.rst', 'duration': '', @@ -88,7 +87,6 @@ }), 'content': '', 'created_at': '', - 'delete': False, 'docname': 'index', 'doctype': '.rst', 'duration': '', @@ -222,12 +220,6 @@ 'field_type': 'extra', 'type': 'string', }), - 'delete': dict({ - 'default': False, - 'description': 'If true, the need is deleted entirely.', - 'field_type': 'core', - 'type': 'boolean', - }), 'docname': dict({ 'default': None, 'description': 'Name of the document where the need is defined (None if external).', diff --git a/tests/__snapshots__/test_external.ambr b/tests/__snapshots__/test_external.ambr index 12f7cbf12..32f701227 100644 --- a/tests/__snapshots__/test_external.ambr +++ b/tests/__snapshots__/test_external.ambr @@ -112,12 +112,6 @@ 'field_type': 'extra', 'type': 'string', }), - 'delete': dict({ - 'default': False, - 'description': 'If true, the need is deleted entirely.', - 'field_type': 'core', - 'type': 'boolean', - }), 'docname': dict({ 'default': None, 'description': 'Name of the document where the need is defined (None if external).', @@ -667,12 +661,6 @@ 'field_type': 'extra', 'type': 'string', }), - 'delete': dict({ - 'default': False, - 'description': 'If true, the need is deleted entirely.', - 'field_type': 'core', - 'type': 'boolean', - }), 'docname': dict({ 'default': None, 'description': 'Name of the document where the need is defined (None if external).', diff --git a/tests/__snapshots__/test_extra_options.ambr b/tests/__snapshots__/test_extra_options.ambr index 65f5c1f77..6a02976a6 100644 --- a/tests/__snapshots__/test_extra_options.ambr +++ b/tests/__snapshots__/test_extra_options.ambr @@ -131,12 +131,6 @@ 'field_type': 'extra', 'type': 'string', }), - 'delete': dict({ - 'default': False, - 'description': 'If true, the need is deleted entirely.', - 'field_type': 'core', - 'type': 'boolean', - }), 'docname': dict({ 'default': None, 'description': 'Name of the document where the need is defined (None if external).', diff --git a/tests/__snapshots__/test_need_constraints.ambr b/tests/__snapshots__/test_need_constraints.ambr index 0ceb7e64c..2c17b932d 100644 --- a/tests/__snapshots__/test_need_constraints.ambr +++ b/tests/__snapshots__/test_need_constraints.ambr @@ -18,7 +18,6 @@ }), 'content': 'This is a requirement describing OPSEC processes.', 'created_at': '', - 'delete': False, 'docname': 'index', 'doctype': '.rst', 'duration': '', @@ -94,7 +93,6 @@ }), 'content': 'Example of a successful constraint.', 'created_at': '', - 'delete': False, 'docname': 'index', 'doctype': '.rst', 'duration': '', @@ -171,7 +169,6 @@ }), 'content': 'Example of a failed constraint.', 'created_at': '', - 'delete': False, 'docname': 'index', 'doctype': '.rst', 'duration': '', @@ -246,7 +243,6 @@ }), 'content': 'Example of a failed constraint with medium severity. Note the style from :ref:`needs_constraint_failed_options`', 'created_at': '', - 'delete': False, 'docname': 'index', 'doctype': '.rst', 'duration': '', @@ -316,7 +312,6 @@ }), 'content': 'The Tool awesome shall have a command line interface.', 'created_at': '', - 'delete': False, 'docname': 'index', 'doctype': '.rst', 'duration': '', @@ -393,7 +388,6 @@ }), 'content': 'asdf', 'created_at': '', - 'delete': False, 'docname': 'index', 'doctype': '.rst', 'duration': '', @@ -470,7 +464,6 @@ }), 'content': '', 'created_at': '', - 'delete': False, 'docname': 'style_test', 'doctype': '.rst', 'duration': '', @@ -544,7 +537,6 @@ }), 'content': '', 'created_at': '', - 'delete': False, 'docname': 'style_test', 'doctype': '.rst', 'duration': '', @@ -678,12 +670,6 @@ 'field_type': 'extra', 'type': 'string', }), - 'delete': dict({ - 'default': False, - 'description': 'If true, the need is deleted entirely.', - 'field_type': 'core', - 'type': 'boolean', - }), 'docname': dict({ 'default': None, 'description': 'Name of the document where the need is defined (None if external).', diff --git a/tests/__snapshots__/test_needextend.ambr b/tests/__snapshots__/test_needextend.ambr index 53afef2ef..bcbd9d8f4 100644 --- a/tests/__snapshots__/test_needextend.ambr +++ b/tests/__snapshots__/test_needextend.ambr @@ -18,7 +18,6 @@ }), 'content': '', 'created_at': '', - 'delete': False, 'docname': 'index', 'doctype': '.rst', 'duration': '', @@ -91,7 +90,6 @@ }), 'content': '', 'created_at': '', - 'delete': False, 'docname': 'index', 'doctype': '.rst', 'duration': '', @@ -162,7 +160,6 @@ }), 'content': '', 'created_at': '', - 'delete': False, 'docname': 'index', 'doctype': '.rst', 'duration': '', @@ -233,7 +230,6 @@ }), 'content': '', 'created_at': '', - 'delete': False, 'docname': 'index', 'doctype': '.rst', 'duration': '', @@ -303,7 +299,6 @@ }), 'content': '', 'created_at': '', - 'delete': False, 'docname': 'index', 'doctype': '.rst', 'duration': '', @@ -438,12 +433,6 @@ 'field_type': 'extra', 'type': 'string', }), - 'delete': dict({ - 'default': False, - 'description': 'If true, the need is deleted entirely.', - 'field_type': 'core', - 'type': 'boolean', - }), 'docname': dict({ 'default': None, 'description': 'Name of the document where the need is defined (None if external).', @@ -820,7 +809,6 @@ Got an outgoing link ``extend_test_004``. ''', 'created_at': '', - 'delete': False, 'docname': 'index', 'doctype': '.rst', 'duration': '', @@ -896,7 +884,6 @@ Got an incoming links ``extend_test_003`` and ``extend_test_006``. ''', 'created_at': '', - 'delete': False, 'docname': 'index', 'doctype': '.rst', 'duration': '', @@ -972,7 +959,6 @@ Both got deleted. ''', 'created_at': '', - 'delete': False, 'docname': 'index', 'doctype': '.rst', 'duration': '', @@ -1043,7 +1029,6 @@ }), 'content': 'Had the link ``extend_test_003``, got another one ``extend_test_004``.', 'created_at': '', - 'delete': False, 'docname': 'index', 'doctype': '.rst', 'duration': '', @@ -1115,7 +1100,6 @@ }), 'content': '', 'created_at': '', - 'delete': False, 'docname': 'index', 'doctype': '.rst', 'duration': '', @@ -1188,7 +1172,6 @@ }), 'content': '', 'created_at': '', - 'delete': False, 'docname': 'page_1', 'doctype': '.rst', 'duration': '', @@ -1325,12 +1308,6 @@ 'field_type': 'extra', 'type': 'string', }), - 'delete': dict({ - 'default': False, - 'description': 'If true, the need is deleted entirely.', - 'field_type': 'core', - 'type': 'boolean', - }), 'docname': dict({ 'default': None, 'description': 'Name of the document where the need is defined (None if external).', diff --git a/tests/__snapshots__/test_needimport.ambr b/tests/__snapshots__/test_needimport.ambr index 23e45be9f..f6b3124f7 100644 --- a/tests/__snapshots__/test_needimport.ambr +++ b/tests/__snapshots__/test_needimport.ambr @@ -1714,12 +1714,6 @@ 'field_type': 'extra', 'type': 'string', }), - 'delete': dict({ - 'default': False, - 'description': 'If true, the need is deleted entirely.', - 'field_type': 'core', - 'type': 'boolean', - }), 'docname': dict({ 'default': None, 'description': 'Name of the document where the need is defined (None if external).', diff --git a/tests/__snapshots__/test_needs_builder.ambr b/tests/__snapshots__/test_needs_builder.ambr index 7e33def5a..f415dc475 100644 --- a/tests/__snapshots__/test_needs_builder.ambr +++ b/tests/__snapshots__/test_needs_builder.ambr @@ -18,7 +18,6 @@ }), 'content': '', 'created_at': '', - 'delete': False, 'docname': 'index', 'doctype': '.rst', 'duration': '', @@ -88,7 +87,6 @@ }), 'content': '', 'created_at': '', - 'delete': False, 'docname': 'index', 'doctype': '.rst', 'duration': '', @@ -158,7 +156,6 @@ }), 'content': '', 'created_at': '', - 'delete': False, 'docname': 'index', 'doctype': '.rst', 'duration': '', @@ -293,12 +290,6 @@ 'field_type': 'extra', 'type': 'string', }), - 'delete': dict({ - 'default': False, - 'description': 'If true, the need is deleted entirely.', - 'field_type': 'core', - 'type': 'boolean', - }), 'docname': dict({ 'default': None, 'description': 'Name of the document where the need is defined (None if external).', @@ -954,12 +945,6 @@ 'field_type': 'extra', 'type': 'string', }), - 'delete': dict({ - 'default': False, - 'description': 'If true, the need is deleted entirely.', - 'field_type': 'core', - 'type': 'boolean', - }), 'docname': dict({ 'default': None, 'description': 'Name of the document where the need is defined (None if external).', @@ -1499,7 +1484,6 @@ }), 'content': '', 'created_at': '', - 'delete': False, 'docname': 'index', 'doctype': '.rst', 'duration': '', @@ -1569,7 +1553,6 @@ }), 'content': '', 'created_at': '', - 'delete': False, 'docname': 'index', 'doctype': '.rst', 'duration': '', @@ -1639,7 +1622,6 @@ }), 'content': '', 'created_at': '', - 'delete': False, 'docname': 'index', 'doctype': '.rst', 'duration': '', @@ -1774,12 +1756,6 @@ 'field_type': 'extra', 'type': 'string', }), - 'delete': dict({ - 'default': False, - 'description': 'If true, the need is deleted entirely.', - 'field_type': 'core', - 'type': 'boolean', - }), 'docname': dict({ 'default': None, 'description': 'Name of the document where the need is defined (None if external).', diff --git a/tests/__snapshots__/test_needs_id_builder.ambr b/tests/__snapshots__/test_needs_id_builder.ambr index a596a524f..838f4b2a3 100644 --- a/tests/__snapshots__/test_needs_id_builder.ambr +++ b/tests/__snapshots__/test_needs_id_builder.ambr @@ -19,7 +19,6 @@ }), 'content': '', 'created_at': '', - 'delete': False, 'docname': 'index', 'doctype': '.rst', 'duration': '', @@ -99,7 +98,6 @@ }), 'content': '', 'created_at': '', - 'delete': False, 'docname': 'index', 'doctype': '.rst', 'duration': '', @@ -179,7 +177,6 @@ }), 'content': '', 'created_at': '', - 'delete': False, 'docname': 'index', 'doctype': '.rst', 'duration': '', diff --git a/tests/__snapshots__/test_service_github.ambr b/tests/__snapshots__/test_service_github.ambr index a6d235119..742b54b77 100644 --- a/tests/__snapshots__/test_service_github.ambr +++ b/tests/__snapshots__/test_service_github.ambr @@ -21,7 +21,6 @@ Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> ''', 'created_at': '2024-02-15T14:04:06Z', - 'delete': False, 'docname': 'index', 'doctype': '.rst', 'duration': '', @@ -98,7 +97,6 @@ ''', 'created_at': '2024-02-15T12:19:11Z', - 'delete': False, 'docname': 'index', 'doctype': '.rst', 'duration': '', @@ -198,7 +196,6 @@ closes #1103 ''', 'created_at': '2024-02-15T20:45:12Z', - 'delete': False, 'docname': 'index', 'doctype': '.rst', 'duration': '', @@ -282,7 +279,6 @@ default as `dropdown`, so as not to introduce a breaking change) ''', 'created_at': '2024-02-12T08:36:07.000Z', - 'delete': False, 'docname': 'index', 'doctype': '.rst', 'duration': '', @@ -410,12 +406,6 @@ 'field_type': 'extra', 'type': 'string', }), - 'delete': dict({ - 'default': False, - 'description': 'If true, the need is deleted entirely.', - 'field_type': 'core', - 'type': 'boolean', - }), 'docname': dict({ 'default': None, 'description': 'Name of the document where the need is defined (None if external).',