Sphinx-needs

Latest version: v5.1.0

Safety actively analyzes 723158 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

Page 5 of 21

08.02.2023

* Bugfix: Fixed pygls version compatibility.
(:pr:`867`,
:pr:`865`)

07.01.2025

:Full Changelog: `v4.1.0...v4.2.0 <https://github.com/useblocks/sphinx-needs/compare/4.1.0...4.2.0>`__

- ⬆️ Drop Python 3.8 and Sphinx 6
- ✨ Add :ref:`needs_import_keys` configuration :pr:`1379`
- 👌 Allow ``filter-func`` in ``needpie`` to have multiple dots in the import path :pr:`1350`
- 🐛 Make external paths relative to ``confdir``, not ``srcdir`` :pr:`1378`
- 🔧 Release needs data mutation lock at end of process :pr:`1359`
- 🔧 Add ``lineno`` to default output of ``needs.json`` :pr:`1346`

06.07.2021

* Improvement: Providing :ref:`needs_external_needs` to allow usage and referencing of external needs.
(:issue:`137`)
* Improvement: New directive :ref:`needextend` to modify or extend existing needs.
(:issue:`282`)
* Improvement: Allowing :ref:`needtable_custom_titles` for :ref:`needtable`.
(:issue:`299`)
* Bugfix: :ref:`needextend` does not support usage of internal options.
(:issue:`318`)
* Bugfix: :ref:`needtable` shows attributes with value ``False`` again.
* Bugfix: ``:hide:`` and ``:collapse: True`` are working inside :ref:`needimport`.
(:issue:`284`,
:issue:`294`)
* Bugfix: :ref:`needpie` amount labels get calculated correctly.
(:issue:`297`)

06.03.2025

:Full Changelog: `v5.0.0...v5.1.0 <https://github.com/useblocks/sphinx-needs/compare/5.0.0...9ad91a92c68899f750081f6d683473080a567cad>`__

The :ref:`needs_global_options` configuration option has been updated to a new format,
to be more explicit and to allow for future improvements :pr:`1413`.
The old format is currently still supported, but will emit a warning.
Additionally, checks are put in place to ensure that the keys used are from the allowed set (:pr:`1410`).:

- any ``needs_extra_options`` field
- any ``needs_extra_links`` field
- ``status``
- ``layout``
- ``style``
- ``tags``
- ``constraints``

.. code-block:: python
:caption: Old format

needs_global_options = {
"field1": "a",
"field2": ("a", 'status == "done"'),
"field3": ("a", 'status == "done"', "b"),
"field4": [
("a", 'status == "done"'),
("b", 'status == "ongoing"'),
("c", 'status == "other"', "d"),
],
}

.. code-block:: python
:caption: New format

needs_global_options = {
"field1": {"default": "a"},
"field2": {"predicates": [('status == "done"', "a")]},
"field3": {
"predicates": [('status == "done"', "a")],
"default": "b",
},
"field4": {
"predicates": [
('status == "done"', "a"),
('status == "ongoing"', "b"),
('status == "other"', "c"),
],
"default": "d",
},
}

5.1.0

-----

5.0.0

-----

Page 5 of 21

© 2025 Safety CLI Cybersecurity Inc. All Rights Reserved.