Sphinxcontrib-needs

Latest version: v0.7.9

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

Scan your dependencies

Page 6 of 16

0.5.4

-----
* Improvement: Added options :ref:`need_pre_template` and :ref:`need_post_template` for needs. (`139 <https://github.com/useblocks/sphinxcontrib-needs/issues/139>`_)
* Bugfix: Setting correct default value for :ref:`needs_statuses` (`136 <https://github.com/useblocks/sphinxcontrib-needs/issues/136>`_)
* Bugfix: Dynamic functions can be used in links (text and url) now.

0.5.3

-----
* Improvement: Added ``transparent`` for transparent background to needflow configurations.
* Improvement: :ref:`needflow` uses directive argument as caption now.
* Improvement: Added option :ref:`needflow_align` to align needflow images.
* Improvement: Added option :ref:`needflow_scale` to scale needflow images. (`127 <https://github.com/useblocks/sphinxcontrib-needs/issues/127>`_)
* Improvement: Added option :ref:`needflow_highlight` to :ref:`needflow`. (`128 <https://github.com/useblocks/sphinxcontrib-needs/issues/128>`_)
* Improvement: :ref:`need_count` supports :ref:`ratio calculation <need_count_ratio>`. (`131 <https://github.com/useblocks/sphinxcontrib-needs/issues/131>`_)
* Improvement: :ref:`needlist`, :ref:`needtable` and :ref:`needflow` support :ref:`filter_code`. (`132 <https://github.com/useblocks/sphinxcontrib-needs/issues/132>`_)
* Improvement: :ref:`needflow` caption is a link to the original image file. (`129 <https://github.com/useblocks/sphinxcontrib-needs/issues/129>`_)
* Bugfix: :ref:`need_template` can now be set via :ref:`needs_global_options`.
* Bugfix: Setting correct urls for needs in :ref:`needflow` charts.
* Bugfix: Setting correct image candidates (`134 <https://github.com/useblocks/sphinxcontrib-needs/issues/134>`_)

0.5.2

-----
* Improvement: ``Sphinx-Needs`` configuration gets checked before build. (`118 <https://github.com/useblocks/sphinxcontrib-needs/issues/118>`_)
* Improvement: ``meta_links_all`` :ref:`layout function <layout_functions>` now supports an exclude parameter
* Improvement: :ref:`needflow`'s :ref:`connection line and arrow type <needflow_style_start>` can be configured.
* Improvement: Configurations added for :ref:`needflow`. Use :ref:`needs_flow_configs` to define them and :ref:`needflow_config` for activation.
* Improvement: :ref:`needflow` option :ref:`needflow_debug` added, which prints the generated PlantUML code after the flowchart.
* Improvement: Supporting Need-Templates by providing need option :ref:`need_template` and
configuration option :ref:`needs_template_folder`. (`119 <https://github.com/useblocks/sphinxcontrib-needs/issues/119>`_)
* Bugfix: :ref:`needs_global_options` handles None values correctly. ``style`` can now be set.
* Bugfix: :ref:`needs_title_from_content` takes ``\n`` and ``.`` as delimiter.
* Bugfix: Setting css-attribute ``white-space: normal`` for all need-tables, which is set badly in some sphinx-themes.
(Yes, I'm looking at you *ReadTheDocs theme*...)
* Bugfix: ``meta_all`` :ref:`layout function <layout_functions>` also outputs extra links and the `no_links`
parameter now works as expected
* Bugfix: Added need-type as css-class back on need. Css class name is ``needs_type_(need_type attribute)``.
(`124 <https://github.com/useblocks/sphinxcontrib-needs/issues/124>`_)
* Bugfix: Need access inside list comprehensions in :ref:`filter_string` is now working.

0.5.1

-----
* Improvement: Added :ref:`needextract` directive to mirror existing needs for special outputs. (`66 <https://github.com/useblocks/sphinxcontrib-needs/issues/66>`_)
* Improvement: Added new styles ``discreet`` and ``discreet_border``.
* Bugfix: Some minor css fixes for new layout system.

0.5.0

-----

* Improvement: Introduction of needs :ref:`layouts_styles`.
* Improvement: Added config options :ref:`needs_layouts` and :ref:`needs_default_layout`.
* Improvement: Added :ref:`needpie` which draws pie-charts based on :ref:`filter_string`.
* Improvement: Added config option :ref:`needs_warnings`. (`110 <https://github.com/useblocks/sphinxcontrib-needs/issues/110>`_)
* Bugfix: Need css style name is now based on need-type and not on the longer, whitespace-containing type name.
Example: ``need-test`` instead of not valid ``need-test case``. (`108 <https://github.com/useblocks/sphinxcontrib-needs/issues/108>`_)
* Bugfix: No more exception raise if ``copy`` value not set inside :ref:`needs_extra_links`.
* Improvement: Better log message, if required id is missing. (`112 <https://github.com/useblocks/sphinxcontrib-needs/issues/112>`_)

* Removed: Configuration option :ref:`needs_collapse_details`. This is now realized by :ref:`layouts`.
* Removed: Configuration option :ref:`needs_hide_options`. This is now realized by :ref:`layouts`.
* Removed: Need option :ref:`need_hide_status`. This is now realized by :ref:`layouts`.
* Removed: Need option :ref:`need_hide_tags`. This is now realized by :ref:`layouts`.

**WARNING**: This version changes a lot the html output and therefore the needed css selectors. So if you are using
custom css definitions you need to update them.

0.4.3

-----

* Improvement: Role :ref:`role_need` supports standard sphinx-ref syntax. Example: ``:need:`custom name <need_id>
* Improvement: Added :ref:`global_option_filters` to set values of global options only under custom circumstances.
* Improvement: Added sorting to :ref:`needtable`. See :ref:`needtable_sort` for details.
* Improvement: Added dynamic function :ref:`links_content` to calculated links to other needs automatically from need-content.
(`98 <https://github.com/useblocks/sphinxcontrib-needs/issues/98>`_)
* Improvement: Dynamic function :ref:`copy` supports uppercase and lowercase transformation.
* Improvement: Dynamic function :ref:`copy` supports filter_string.
* Bugfix: Fixed corrupted :ref:`dynamic_functions` handling for ``tags`` and other list options.
(`100 <https://github.com/useblocks/sphinxcontrib-needs/issues/100>`_)
* Bugfix: Double entries for same need in :ref:`needtable` fixed. (`93 <https://github.com/useblocks/sphinxcontrib-needs/issues/93>`_)

Page 6 of 16

© 2025 Safety CLI Cybersecurity Inc. All Rights Reserved.