Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🔧 Remove hidden field from extra_options #1124

Merged
merged 3 commits into from
Feb 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 0 additions & 11 deletions docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -155,17 +155,6 @@ And use it like:
:tags: important;complex;
:impacts: really everything

Default value:

.. code-block:: python

{'hidden': directives.unchanged}

The ``hidden`` option is a globally available option always hidden and used to easily execute :ref:`dynamic_functions`.

Extra options automatically appear in needs, if a value is set.
By using :ref:`needs_hide_options` the output of such options can be hidden.

.. note:: To filter on these options in `needlist`, `needtable`, etc. you
must use the :ref:`filter` option.

Expand Down
2 changes: 0 additions & 2 deletions docs/examples/needs.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@
"github": "",
"has_dead_links": "",
"has_forbidden_dead_links": "",
"hidden": "",
"hours": "",
"id": "test_req",
"id_complete": "test_req",
Expand Down Expand Up @@ -113,7 +112,6 @@
"github": "",
"has_dead_links": "",
"has_forbidden_dead_links": "",
"hidden": "",
"hours": "",
"id": "xyz_123",
"id_complete": "xyz_123",
Expand Down
1 change: 0 additions & 1 deletion sphinx_needs/data.py
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,6 @@ class NeedsInfoType(TypedDict):

# default extra options
# TODO these all default to "" which I don't think is good
hidden: str
duration: str
completion: str
# constraints: str # this is already set in create_need
Expand Down
1 change: 0 additions & 1 deletion sphinx_needs/needs.py
Original file line number Diff line number Diff line change
Expand Up @@ -514,7 +514,6 @@ def prepare_env(app: Sphinx, env: BuildEnvironment, _docname: str) -> None:

# Own extra options
for option in [
"hidden",
"duration",
"completion",
"constraints",
Expand Down
2 changes: 0 additions & 2 deletions tests/__snapshots__/test_basic_doc.ambr
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@
'full_title': 'Test story',
'has_dead_links': False,
'has_forbidden_dead_links': False,
'hidden': '',
'id': 'ST_001',
'id_prefix': '',
'is_external': False,
Expand Down Expand Up @@ -99,7 +98,6 @@
'full_title': 'No ID',
'has_dead_links': False,
'has_forbidden_dead_links': False,
'hidden': '',
'id': 'US_38823',
'id_prefix': '',
'is_external': False,
Expand Down
8 changes: 0 additions & 8 deletions tests/__snapshots__/test_export_id.ambr
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,6 @@
'full_title': 'My requirement',
'has_dead_links': False,
'has_forbidden_dead_links': False,
'hidden': '',
'id': 'REQ_001',
'id_prefix': '',
'is_external': False,
Expand Down Expand Up @@ -213,7 +212,6 @@
'full_title': 'My requirement 2',
'has_dead_links': False,
'has_forbidden_dead_links': False,
'hidden': '',
'id': 'REQ_002',
'id_prefix': '',
'is_external': False,
Expand Down Expand Up @@ -286,7 +284,6 @@
'full_title': 'My requirement 3',
'has_dead_links': False,
'has_forbidden_dead_links': False,
'hidden': '',
'id': 'REQ_003',
'id_prefix': '',
'is_external': False,
Expand Down Expand Up @@ -359,7 +356,6 @@
'full_title': 'My requirement 4',
'has_dead_links': False,
'has_forbidden_dead_links': False,
'hidden': '',
'id': 'REQ_004',
'id_prefix': '',
'is_external': False,
Expand Down Expand Up @@ -437,7 +433,6 @@
'full_title': 'Req 5',
'has_dead_links': False,
'has_forbidden_dead_links': False,
'hidden': '',
'id': 'REQ_005',
'id_prefix': '',
'is_external': False,
Expand Down Expand Up @@ -541,7 +536,6 @@
'full_title': 'Test of requirements',
'has_dead_links': False,
'has_forbidden_dead_links': False,
'hidden': '',
'id': 'TEST_001',
'id_prefix': '',
'is_external': False,
Expand Down Expand Up @@ -616,7 +610,6 @@
'full_title': 'Test of requirements2',
'has_dead_links': False,
'has_forbidden_dead_links': False,
'hidden': '',
'id': 'TEST_002',
'id_prefix': '',
'is_external': False,
Expand Down Expand Up @@ -691,7 +684,6 @@
'full_title': 'Test of requirements 5',
'has_dead_links': False,
'has_forbidden_dead_links': False,
'hidden': '',
'id': 'TEST_003',
'id_prefix': '',
'is_external': False,
Expand Down
5 changes: 0 additions & 5 deletions tests/__snapshots__/test_external.ambr
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@
'full_title': 'TEST_01 DESCRIPTION',
'has_dead_links': False,
'has_forbidden_dead_links': False,
'hidden': '',
'id': 'EXT_TEST_01',
'id_prefix': '',
'is_external': True,
Expand Down Expand Up @@ -99,7 +98,6 @@
'full_title': 'TEST_02 DESCRIPTION',
'has_dead_links': False,
'has_forbidden_dead_links': False,
'hidden': '',
'id': 'EXT_TEST_02',
'id_prefix': '',
'is_external': True,
Expand Down Expand Up @@ -170,7 +168,6 @@
'full_title': 'Test requirement 1',
'has_dead_links': False,
'has_forbidden_dead_links': False,
'hidden': '',
'id': 'REQ_1',
'id_prefix': '',
'is_external': False,
Expand Down Expand Up @@ -238,7 +235,6 @@
'full_title': 'Test specification 1',
'has_dead_links': False,
'has_forbidden_dead_links': False,
'hidden': '',
'id': 'SPEC_1',
'id_prefix': '',
'is_external': False,
Expand Down Expand Up @@ -308,7 +304,6 @@
'full_title': 'Sub-Req',
'has_dead_links': False,
'has_forbidden_dead_links': False,
'hidden': '',
'id': 'SUB_002',
'id_prefix': '',
'is_external': False,
Expand Down
Loading
Loading