Changelog

0.3.10

• Bugfix: type was missing in output of builder needs (#79 )
• Bugfix: needs_functions parameter in conf.py created a sphinx error, if containing python methods. Internal workaround added, so that usage of own Dynamic functions stays the same as in prior versions (#78 )

0.3.9

• Bugfix: Grubby tag/link strings in needs, which define empty links/tags, produce a warning now.
• Bugfix: Better logging of document location, if a filter string is not valid.
• Bugfix: Replaced all print-statements with sphinx warnings.

0.3.8

• Improvement: need_part / np has now attributes id_parent and id_complete, which can be referenced in Filter string.
• Improvement: needtable supports presentation of filtered need_part / np (without showing parent need).

0.3.7

• Improvement: Filter string now supports the filtering of need_part / np.
• Improvement: The ID of a need is now printed as link, which can easily be used for sharing. (#75 )
• Bugfix: Filter functionality in different directives are now using the same internal filter function.
• Bugfix: Reused IDs for a need_part / np are now detected and a warning gets printed. (#74 )

0.3.6

• Improvement: Added needtable option show_parts.
• Improvement: Added configuration option needs_part_prefix.
• Improvement: Added docname to output file of builder needs
• Bugfix: Added missing needs_import template to MANIFEST.ini.

0.3.5

• Bugfix: A need_part / np without a given ID gets a random id based on its content now.
• Bugfix: Calculation of outgoing links does not crash, if need_parts are involved.

0.3.4

• Bugfix: Need representation in PDFs were broken (e.g. all meta data on one line).

0.3.3

• Bugfix: Latex and Latexpdf are working again.

0.3.2

• Bugfix: Links to parts of needs (need_part / np) are now stored and presented as links incoming of target link.

0.3.1

• Improvement: Added dynamic function check_linked_values.
• Improvement: Added dynamic function calc_sum.
• Improvement: Added role need_count, which shows the amount of found needs for a given filter-string.

• Bugfix: Links to need_part / np in needflow are now shown correctly as extra line between

  need_parts containing needs.

• Bugfix: Links to need_part / np in needtable are now shown and linked correctly in tables.

0.3.0

• Improvement: Dynamic functions are now available to support calculation of need values.
• Improvement: needs_functions can be used to register and use own dynamic functions.
• Improvement: Added needs_global_options to set need values globally for all needs.
• Improvement: Added needs_hide_options to hide specific options of all needs.
• Bugfix: Removed needs are now deleted from existing needs.json (#68 )
• Removed: needs_template and needs_template_collapse are no longer supported.

0.2.5

• Bugfix: Fix for changes made in 0.2.5.

0.2.4

• Bugfix: Fixed performance issue (#63 )

0.2.3

• Improvement: Titles can now be made optional. See needs_title_optional. (#49)
• Improvement: Titles be auto-generated from the first sentence of a requirement. See needs_title_from_content and title_from_content. (#49)
• Improvement: Titles can have a maximum length. See needs_max_title_length. (#49)

0.2.2

• Improvement: The sections, to which a need belongs, are now stored, filterable and exported in needs.json. See updated filter. (#53 )
• Improvement: Project specific options for needs are supported now. See needs_extra_options. (#48 )
• Bugfix: Logging fixed (#50 )
• Bugfix: Tests for custom styles are now working when executed with all other tests (#47 )

0.2.1

• Bugfix: Sphinx warnings fixed, if need-collapse was used. (#46 )
• Bugfix: dark.css, blank.css and common.css used wrong need-container selector. Fixed.

0.2.0

• Deprecated: needfilter is replaced by needlist, needtable or needflow. Which support additional options for related layout.
• Improvement: Added needtable directive.
• Improvement: Added DataTables support for needtable (including table search, excel/pdf export and dynamic column selection).
• Improvement: Added needs_id_regex, which takes a regular expression and which is used to validate given IDs of needs.
• Improvement: Added meta information shields on documentation page
• Improvement: Added more examples to documentation
• Bugfix: Care about unneeded separator characters in tags (#36)
• Bugfix: Avoiding multiple registration of resource files (js, css), if sphinx gets called several times (e.g. during tests)
• Bugfix: Needs with no status shows up on filters (#45)
• Bugfix: Supporting Sphinx 1.7 (#41)

0.1.49

• Bugfix: Supporting plantnuml >= 0.9 (#38)
• Bugfix: need_outgoing does not crash, if given need-id does not exist (#32 )

0.1.48

• Improvement: Added configuration option needs_role_need_template.
• Bugfix: Referencing not existing needs will result in build warnings instead of a build crash.

• Refactoring: needs development files are stored internally under sphinxcontrib/needs, which is in sync with

  most other sphinxcontrib-packages.

0.1.47

• Bugfix: dark.css was missing in MANIFEST.in.
• Improvement: Better output, if configured needs_css file can not be found during build.

0.1.46

• Bugfix: Added python2/3 compatibility for needs_import.

0.1.45

• Bugfix: needs with no status are handled the correct way now.

0.1.44

• Bugfix: Import statements are checked, if Python 2 or 3 is used.

0.1.43

• Improvement: Added “dark.css” as style
• Bugfix: Removed “,” as as separator of links in need presentation.

0.1.42

• Improvement: Added config parameter needs_css, which allows to set a css file.
• Improvement: Most need-elements (title, id, tags, status, …) got their own html class attribute to support custom styles.
• Improvement: Set default style “modern.css” for all projects without configured needs_css parameter.

0.1.41

• Improvement: Added config parameters needs_statuses and needs_tags to allow only configured statuses/tags inside documentation.
• Bugfix: Added LICENSE file (MIT)

0.1.40

• Bugfix: Removed jinja activation

0.1.39

• Bugfix: Added missing needimport_template.rst to package
• Bugfix: Corrected version param of needimport

0.1.38

• Improvement: :links:, :tags: and other list-based options can handle “,” as delimiter

  (beside documented “;”). No spooky errors are thrown anymore if “,” is used accidentally.

0.1.37

• Bugfix: Implemented 0.1.36 bugfix also for needfilter and needimport.

0.1.36

• Bugfix: Empty :links: and :tags: options for need/ req (or any other defined need type) raise no error during build.

0.1.35

• Improvement/Bug: Updated default node_template to use less space for node parameter representation
• Improvement: Added :filter: option to needimport directive
• Bugfix: Set correct default value for need_list option. So no more warnings should be thrown during build.
• Bugfix: Imported needs gets sorted by id before adding them to the related document.

0.1.34

• Improvement: New option tags for needimport directive
• Bugfix: Handling of relative paths in needs builder

0.1.33

• New feature: Directive needimport implemented
• Improvement: needs-builder stores needs.json for all cases in the build directory (like _build/needs/needs.json) (See issue comment)
• Bugfix: Wrong version in needs.json, if an existing needs.json got imported
• Bugfix: Wrong need amount in initial needs.json fixed

0.1.32

• Bugfix: Setting correct working directory during conf.py import
• Bugfix: Better config handling, if Sphinx builds gets called multiple times during one single python process. (Configs from prio sphinx builds may still be active.)
• Bugifx: Some cleanups for using Sphinx >= 1.6

0.1.31

• Bugfix: Added missing dependency to setup.py: Sphinx>=1.6

0.1.30

• Improvement: Builder needs added, which exports all needs to a json file.

0.1.29

• Bugfix: Build has crashed, if sphinxcontrib-needs was loaded but not a single need was defined.

0.1.28

• Bugfix: Added support for multiple sphinx projects initialisations/builds during a single python process call.

  (Reliable sphinxcontrib-needs configuration separation)

0.1.27

• New config: needs_show_link_type
• New config: needs_show_link_title

0.1.26

• Bugfix: Working placement of “,” for links list produced by roles need_outgoing

  and need_incoming.

0.1.25

• Restructured code
• Restructured documentation
• Improvement: Role need_outgoing was added to print outgoing links from a given need
• Improvement: Role need_incoming was added to print incoming links to a given need

0.1.24

• Bugfix: Reactivated jinja execution for documentation.

0.1.23

• Improvement: complex filter for needfilter directive supports regex searches.
• Improvement: complex filter has access to nearly all need variables (id, title, content, …)`.
• Bugfix: If a duplicated ID is detected an error gets thrown.

0.1.22

• Improvement: needfilter directives supports complex filter-logic by using parameter Filtering needs.

0.1.21

• Improvement: Added word highlighting of need titles in linked pages of svg diagram boxes.

0.1.20

• Bugfix for custom needs_types: Parameter in conf.py was not taken into account.

0.1.19

• Added configuration parameter needs_id_required.
• Backwards compatibility changes:
• Reimplemented needlist as alias for needfilter
• Added need directive/need as part of the default needs_types configuration.

0.1.18

Initial start for the changelog

• Free definable need types (Requirements, Bugs, Tests, Employees, …)
• Allowing configuration of needs with a
• directive name
• meaningful title
• prefix for generated IDs
• color
• Added needfilter directive
• Added layouts for needfilter:
• list (default)
• table
• diagram (based on plantuml)
• Integrated interaction with the activated plantuml sphinx extension
• Added role need to create a reference to a need by giving the id