Improve pie charts

Only the item-piechart directive has been modified [PR #304]:

Added:

• The title can be hidden with the flag :hidetitle:.
• The generated images have the class pie-chart for easier manipulation with CSS.
• Use svg for HTML and pdf for PDF output instead of png.

Fixed:

• Long labels were not fully rendered. The image width now adapts to the length of the labels instead of being fixed.

Fix broken relationship links in HTML output

Fixed:

• item directive: some relationship links were broken in HTML format [PR #303]

Fix bug that causes some relationships to be hidden

Fixed:

• item directive: Not all relationships are listed [PR #302]

Improvements to item matrix for displaying intermediates

One of the major backwards compatibility changes to item-matrix are:

• splitintermediates now displays all intermediates, regardless of the covered status
• if you have both coveredintermediates and splitintermediates to achieve previous behavior remove the splitintermediates.

The build performance (speed and memory usage) was greatly improved in this version. Over 20% less memory is used in big projects for building a item database, and quite some optimizations were added to improve the build time.

Deprecation of attributes in this version:

The time has come to also deprecate some of the options which in 8.x produced warnings, but now they have been removed and will produce an error. Both two options you can use a simple search and replace or use sed:

• option 'sourceattributes' in item-matrix is deprecated. Use 'sourcecolumns' instead. sed -i "s/:sourceattributes:/:sourcecolumns:/g" *.rst
• option 'targetattributes' in item-matrix is deprecated. Use 'targetcolumns' instead. sed -i "s/:targetattributes:/:targetcolumns:/g" *.rst
• support for Python 3.5 and 3.6 was dropped.

What's Changed

• Improve performance when there are many traceable items by @JasperCraeghs in #290
• Display uncovered intermediates by default in item matrix by @gcrabbe in #285
• Drop support for Python<=3.6 and support Python 3.10 by @JasperCraeghs in #294
• Use compiled regex patterns to reduce function calls by @JasperCraeghs in #293
• Deprecate non-pythonic code by @JasperCraeghs in #295
• Remove the use of OrderedDict by @JasperCraeghs in #298
• Store internal reference nodes by @JasperCraeghs in #297
• Delete variables as soon as they are no longer needed by @JasperCraeghs in #299
• Remove deprecated options for v9 by @JasperCraeghs in #300
• Use lower case to link to a TraceableAttribute by @JasperCraeghs in #301

Full Changelog: v8.9.0...v9.0.0

Added features to item-piechart and item-matrix directives

Added:

• item-piechart directive: Support filtering and labeling by relationship type by adding the :sourcetype: and :targettype: options [PR #283]
• item-matrix directive: Add :filtertarget: flag [PR #284]

Fixed:

• item-piechart directive: Fixed a corner case in which the wrong label was used to label a source item that is covered by more than one target [PR #283]

No longer generate a blank image for an empty item-piechart

• Fix: No longer generate a blank image for an empty item-piechart [PR #278]
• Document how regular expressions are handled [PR #279]
• Address docutils deprecation warnings [PR #280]
• Refactor query_checklist [PR #277]

Add option to decide on git platform for checklist items

The most prominent option now is that if your API URL does not contain github or gitlab, you can still define the git platform in your conf.py and enable proper querying of the instance to fill in/embed merge request (or pull request) checklists in your documentation

Secondary the declaration for parallel build/write was also added as that solves a warning and a contact information fixup.

Add features to item-piechart directive

• Support configuration of the colors of the item-piechart [PR #267]
• Support filtering of source items on attributes in item-piechart [PR #266]
• Minor refactoring [PR #259, #265]

Add secondary callback function to inspect items

Add secondary callback function traceability_inspect_item, which can be defined in conf.py to inspect traceable items and detect gaps in your documentation [PR #258]

Fix class option of item directive

Make :class: option work for item directive [PR #256]