Sphinx-needs

Latest version: v2.1.0

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

Scan your dependencies

Page 4 of 19

08.10.2021

* Improvement: New config option :ref:`needs_builder_filter` to define a filter for the needs builder.
(:issue:`342`)
* Improvement: Added option ``json_path`` for :ref:`needs_external_needs` to support external needs from local ``needs.json`` files.
(:issue:`339`)
* Improvement: Providing :ref:`needs_table_classes` to allow to set custom table css classes, to better support
themes like ReadTheDocs.
(:issue:`305`)
* Improvement: Supporting user defined filter code function for :ref:`needs_warnings`
(:issue:`345`)
* Improvement: Supporting caption for :ref:`needtable`
(:issue:`348`)
* Improvement: New config option :ref:`needs_filter_data` to allow to use custom data inside a :ref:`filter_string`
(:issue:`317`)
* Improvement: API to register warnings
(:issue:`343`)
* Bugfix: Scrolling tables improved and ReadTheDocs Tables fixed
(:issue:`305`)
* Bugfix: :ref:`needtable` need parts 'id' column is not linked
(:issue:`336`)
* Bugfix: :ref:`needtable` need parts 'incoming' column is empty
(:issue:`336`)
* Bugfix: :ref:`needs_warnings` not written to error log.
(:issue:`344`)
* Improvement: Providing :ref:`needs_warnings_always_warn` to raise sphinx-warnings for each not passed :ref:`needs_warnings`.
(:issue:`344`)
* Bugfix: :ref:`needimport` relative path not consistent to Sphinx default directives.
(:issue:`351`)

08.05.2024

:Full Changelog: `v2.0.0...v2.1.0 <https://github.com/useblocks/sphinx-needs/compare/2.0.0...d405fd1>`__

Improvements
............

- 👌 Default to warning for missing ``needextend`` ID in :pr:`1066`
- 👌 Make ``needtable`` titles more permissive in :pr:`1102`
- 👌 Add ``filter_warning`` directive option, to replace default warning text in :pr:`1093`
- 👌 Improve and test github ``needservice`` directive in :pr:`1113`
- 👌 Improve warnings for invalid filters (add source location and subtype) in :pr:`1128`
- 👌 Exclude external needs from ``needs_id_regex`` check in :pr:`1108`
- 👌 Fail and emit warning on filters that do not return a boolean result in :pr:`964`
- 👌 Improve ``Need`` node creation and content parsing in :pr:`1168`
- 👌 Add loading message to ``permalink.html`` in :pr:`1081`
- 👌 Remove hard-coding of ``completion`` and ``duration`` need fields in :pr:`1127`

Bug fixes
.........

- 🐛 Image layout function in :pr:`1135`
- 🐛 Centralise splitting of need ID in :pr:`1101`
- 🐛 Centralise need missing link reporting in :pr:`1104`

Internal improvements
......................

- 🔧 Use future annotations in all modules in :pr:`1111`
- 🔧 Replace black/isort/pyupgrade/flake8 with ruff in :pr:`1080`

- 🔧 Add better typing for ``extra_links`` config variable in :pr:`1131`
- 🔧 Centralise need parts creation and strongly type needs in :pr:`1129`
- 🔧 Fix typing of need docname/lineno in :pr:`1134`
- 🔧 Type ``ExternalSource`` config dict in :pr:`1115`
- 🔧 Enforce type checking in ``needuml.py`` in :pr:`1116`
- 🔧 Enforce type checking in ``api/need.py`` in :pr:`1117`
- 🔧 Add better typing for ``global_options`` config variable in :pr:`1120`

- 🔧 Move dead link need fields to internals in :pr:`1119`
- 🔧 Remove usage of ``hide_status`` and ``hide_tags`` in :pr:`1130`
- 🔧 Remove ``hidden`` field from ``extra_options`` in :pr:`1124`
- 🔧 Remove ``constraints`` from ``extra_options`` in :pr:`1123`
- 🔧 Remove use of deprecated ``needs_extra_options`` as ``dict`` in :pr:`1126`

08.02.2023

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

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`)

04.03.2022

* Bugfix: ``need`` role supporting lower and upper IDs.
(:issue:`508`)
* Bugfix: Correct image registration to support build via Sphinx API.
(:issue:`505`)
* Bugfix: Correct css/js file registration on windows.
(:issue:`455`)

2.1.0

-----

Page 4 of 19

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.