v2.0.0
See: https://sphinx-needs.readthedocs.io/en/latest/changelog.html
This release is focussed on improving the internal code-base and its build time performance, as well as improved build warnings and other functionality improvements / fixes.
What's Changed
- π Performance: Memoize Inline parser for
build_need
by @chrisjsewell in #968 - Easier Sphinx-Needs docs builds by @danwos in #972
- β»οΈ Change
NeedsBuilder
format toneeds
by @chrisjsewell in #978 - π Improve sphinx warnings by @chrisjsewell in #975
- π DOCS: Always use headless plantuml by @chrisjsewell in #983
- π Fix gantt chart rendering by @chrisjsewell in #984
- π Improve plantuml warnings by @chrisjsewell in #982
- π§ Replace
Directive
withSphinxDirective
by @chrisjsewell in #986 - π§ͺ Add headless java to test builds by @chrisjsewell in #988
- π§ͺ Remove all make files in test build folders by @chrisjsewell in #989
- π DOCS: Add intersphinx by @chrisjsewell in #991
- π§ͺ Remove boilerplate from test build
conf.py
files by @chrisjsewell in #990 - π Fix execute_func by @chrisjsewell in #994
- π Improve logging for static file copies by @chrisjsewell in #992
- π§ Centralise access to sphinx-needs config by @chrisjsewell in #998
- π§ Centralise sphinx
env
data access (and add schemas) by @chrisjsewell in #987 - π§ Add strict typing for
sphinx_needs.builder
by @chrisjsewell in #1000 - π§ Make
NEEDS_CONFIG
type safe by @chrisjsewell in #1001 - π§ Make mypy pre-commit hook isolated by @chrisjsewell in #1003
- ππ§ MERGE: Add strict typing for most
sphinx_needs
modules by @chrisjsewell in #1002 - Bump cypress-io/github-action from 5 to 6 by @dependabot in #981
- π Fix adding sections to hidden needs by @chrisjsewell in #995
- π FIX:
NeedImport
logic by @chrisjsewell in #1006 - π Fix creation of need title nodes by @chrisjsewell in #1008
- Namnn/need per id json by @nhatnamnguyengtvthcm in #960
- π DOCS: Add outline of extension logic by @chrisjsewell in #1012
- π Improve removal of hidden need nodes by @chrisjsewell in #1013
- π Improve
process_constraints
by @chrisjsewell in #1015 - Fixed extra links example by @piotr-zyskowski-rai in #1016
- π§ Remove
unwrap
function by @chrisjsewell in #1017 - π§ͺ Add snapshot testing for needs data by @chrisjsewell in #1019
- Bump docker/build-push-action from 2 to 5 by @dependabot in #1024
- Bump docker/setup-buildx-action from 2 to 3 by @dependabot in #1023
- Bump docker/metadata-action from 4 to 5 by @dependabot in #1022
- Bump docker/login-action from 1 to 3 by @dependabot in #1021
- Bump actions/checkout from 3 to 4 by @dependabot in #1009
- π§ͺ Add snapshot testing for cached doctrees by @chrisjsewell in #1020
- π Optimize needextend filter_needs usage by @danwos in #1030
- π From string fix by @danwos in #1031
- π Improve logic for
process_needextend
by @chrisjsewell in #1037 - π Removing deepcopy by @danwos in #1033
- π§ͺ CI: Make documentation builds fail on warnings by @chrisjsewell in #1005
- β¨ Add error messages for constraint failures by @chrisjsewell in #1036
- π§ Consolidate needs data post-processing by @chrisjsewell in #1039
- β»οΈ Refactor needs post-processing function signatures by @chrisjsewell in #1040
- π§ Add strict typing for
sphinx_needs.functions.functions
by @chrisjsewell in #1042 - Fix usage of reST syntax in prefix parameter of meta by @sleiner in #1046
- π Allow
needextend
to use dynamic functions by @chrisjsewell in #1052 - π Remove some unnecessary keys from
needs.json
by @chrisjsewell in #1053 - π Improve performance of needs builders by @chrisjsewell in #1054
- π§ͺ Testing of JS scripts using Cypress integrated into PyTest by @iSOLveIT in #1051
- Add
check
CI job by @chrisjsewell in #1058 - Remove node install from core tests CI by @chrisjsewell in #1057
- π§ͺ Remove plantuml config from test builds conf.py by @chrisjsewell in #1059
- β¬οΈ Update to Sphinx 7 by @chrisjsewell in #1056
- π§ Fix benchmark.yaml CI regression by @chrisjsewell in #1062
- π§ Add
remove_node_from_tree
utility function by @chrisjsewell in #1063 - β¨ NEW:
needs_reproducible_json
config option by @chrisjsewell in #1065 - β»οΈ Make matplotlib dependency optional by @chrisjsewell in #1061
- π§ͺ Add code coverage to CI testing by @chrisjsewell in #1067
- π§ Bump actions/setup-node from 3 to 4 by @dependabot in #1050
- π Release v2.0.0 by @chrisjsewell in #1068
- π§ͺ Test README builds in pre-commit by @chrisjsewell in #1069
- π Pin pydantic version by @chrisjsewell in #1071
- π§ Fix Docker deployment by @chrisjsewell in #1070
New Contributors
- @nhatnamnguyengtvthcm made their first contribution in #960
- @piotr-zyskowski-rai made their first contribution in #1016
- @sleiner made their first contribution in #1046
Full Changelog: 1.3.0...2.0.0