Sphinx-needs

Latest version: v4.1.0

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

Scan your dependencies

Page 1 of 20

30.11.2021

* Improvement: Adds :ref:`needservice_debug` flag for :ref:`needservice`.
* Improvement: Better css table handling.
* Improvement: Adds :ref:`needtable_class` to :ref:`needtable` to set own css classes for tables.
(:issue:`421`)
* Improvement: Adds :ref:`needs_string_links` to support easy string2link transformations.
(:issue:`404`)
* Improvement: Adds :ref:`needtable_colwidths` to :ref:`needtable` directive, to allow the definition of column widths.
(:issue:`402`)

30.04.2021

* Improvement: Parent needs of nested needs get collected and are available in filters.
(:issue:`249`)
* Bugfix: Copying static files during sphinx build is working again.
(:issue:`252`)
* Bugfix: Link function for layouts setting correct text.
(:issue:`251`)

29.03.2022

* Improvement: Provides line number info for needs node.
(:issue:`499`)
* Bugfix: :ref:`needpie` causing a crash in some cases on newer matplotlib versions.
(:issue:`513`,
:issue:`517`)
* Bugfix: :ref:`needpie` takes need-parts in account for filtering.
(:issue:`514`)
* Bugfix: Empty and invalid ``need.json`` files throw user-friendly exceptions.
(:issue:`441`)

28.10.2024

:Full Changelog: `v4.0.0...v4.1.0 <https://github.com/useblocks/sphinx-needs/compare/4.0.0...94b0273fbf51ac467f9cfb829b3ef476667f01b2>`__

New
...

- ✨ Add `needs_from_toml` configuration :pr:`1337`

Configuration can now be loaded from a TOML file, using the `needs_from_toml` configuration option.
See :ref:`needs_from_toml` for more information.

- ✨ Allow configuring description of extra options in ``needs_extra_options`` :pr:`1338`

The ``needs_extra_options`` configuration option now supports dict items with a ``name`` and ``description`` key,
See :ref:`needs_extra_options` for more information.

Fixes
.....

- 🐛 Fix clickable links to needs in ``needflow``, when using the ``graphviz`` engine :pr:`1339`
- 🐛 Allow sphinx-needs to run without ``sphinxcontrib.plantuml`` installed :pr:`1328`
- 🔧 Remove some internal fields from needs layout :pr:`1330`
- 🔧 Merge defaults into user-defined configuration earlier (to avoid sphinx warnings) :pr:`1341`

28.08.2024

:Full Changelog: `v2.1.0...v3.0.0 <https://github.com/useblocks/sphinx-needs/compare/2.1.0...59cc6bf>`__

This release includes a number of new features and improvements, as well as some bug fixes.

Updated dependencies
....................

- sphinx: ``>=5.0,<8`` to ``>=6.0,<9``
- requests: ``^2.25.1`` to ``^2.32``
- requests-file: ``^1.5.1`` to ``^2.1``
- sphinx-data-viewer: ``^0.1.1`` to ``^0.1.5``

Documentation and CSS styling
..............................

The documentation theme has been completely updated, and a tutorial added.

To improve ``sphinx-needs`` compatibility across different Sphinx HTML themes,
the CSS for needs etc has been modified substantially, and so,
if you have custom CSS for your needs, you may need to update it.

See :ref:`install_theme` for more information on how to setup CSS for different themes,
and :pr:`1178`, :pr:`1181`, :pr:`1182` and :pr:`1184` for the changes.

``needflow`` improvements
..........................

The use of `Graphviz <https://graphviz.org/>`__ as the underlying engine for `needflow` diagrams, in addition to the default `PlantUML <http://plantuml.com>`__,
is now allowed via the global :ref:`needs_flow_engine` configuration option, or the per-diagram :ref:`engine <needflow_engine>` option.

The intention being to simplify and improve performance of graph builds, since ``plantuml`` has issues with JVM initialisation times and reliance on a third-party sphinx extension.

See :ref:`needflow` for more information,
and :pr:`1235` for the changes.

additional improvements:

- ✨ Allow setting an ``alt`` text for ``needflow`` images
- ✨ Allow creating a ``needflow`` from a ``root_id`` in :pr:`1186`
- ✨ Add ``border_color`` option for ``needflow`` in :pr:`1194`

``needs.json`` improvements
............................

A ``needs_schema`` is now included in the ``needs.json`` file (per version), which is a JSON schema for the data structure of a single need.

This includes defaults for each field, and can be used in combination with the :ref:`needs_json_remove_defaults` configuration option to remove these defaults from each individual need.

Together with the new automatic minifying of the ``needs.json`` file, this can reduce the file size by down to 1/8th of its previous size.

The :ref:`needs_json_exclude_fields` configuration option can also be used to modify the excluded need fields from the ``needs.json`` file,
and backlinks are now included in the ``needs.json`` file by default.

See :ref:`needs_builder_format` for more information,
and :pr:`1230`, :pr:`1232`, :pr:`1233` for the changes.

Additionally, the ``content_node``, ``content_id`` fields are removed from the internal need data structure (see :pr:`1241` and :pr:`1242`).

Additional improvements
.......................

- 👌 Capture filter processing times when using ``needs_debug_measurement=True`` in :pr:`1240`
- 👌 Allow ``style`` and ``color`` fields to be omitted for ``needs_types`` items and a default used in :pr:`1185`
- 👌 Allow ``collapse`` / ``delete`` / ``jinja_content`` directive options to be flags in :pr:`1188`
- 👌 Improve ``need-extend``; allow dynamic functions in lists in :pr:`1076`
- 👌 Add collapse button to ``clean_xxx`` layouts in :pr:`1187`

- 🐛 fix warnings for duplicate needs in parallel builds in :pr:`1223`
- 🐛 Fix rendering of ``needextract`` needs and use warnings instead of exceptions in :pr:`1243` and :pr:`1249`

28.02.2022

* Improvement: :ref:`filter_func` support arguments.
(:issue:`429`)
* Improvement: Adds :ref:`needs_build_json` config option to build ``needs.json`` in parallel to other output formats.
(:issue:`485`)
* Improvement: Migrate tests to Pytest and Sphinx internal testing structure.
(:issue:`471`)
* Bugfix: :ref:`needs_builder` supports incremental build (no doctree deletion).
(:issue:`481`)
* Bugfix: :ref:`needs_external_needs` working with :ref:`role_need`.
(:issue:`483`)

Page 1 of 20

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.