Sphinxcontrib Needs Versions Save

Adds needs/requirements to sphinx

2.1.0

1 week ago

What's Changed

Improvements

👌 Default to warning for missing needextend ID by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1066
👌 Make needtable titles more permissive by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1102
👌 Add filter_warning directive option, to replace default warning text by @kreuzberger in https://github.com/useblocks/sphinx-needs/pull/1093
👌 Improve and test github needservice directive by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1113
👌 Improve warnings for invalid filters (add source location and subtype) by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1128
👌 Exclude external needs from needs_id_regex check by @David-Le-Nir in https://github.com/useblocks/sphinx-needs/pull/1108
👌 Fail and emit warning on filters that do not return a boolean result by @big1hc in https://github.com/useblocks/sphinx-needs/pull/964
👌 Improve Need node creation and content parsing by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1168
👌 Add loading message to permalink.html by @csIcaK in https://github.com/useblocks/sphinx-needs/pull/1081
👌 Remove hard-coding of completion and duration need fields by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1127

Bug fixes

🐛 Image layout function by @danwos in https://github.com/useblocks/sphinx-needs/pull/1135
🐛 Centralise splitting of need ID by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1101
🐛 Centralise need missing link reporting by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1104

Internal improvements

🔧 Use future annotations in all modules by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1111
🔧 Replace black/isort/pyupgrade/flake8 with ruff by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1080
🔧 Add better typing for extra_links config variable by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1131
🔧 Centralise need parts creation and strongly type needs by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1129
🔧 Fix typing of need docname/lineno by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1134
🔧 Type ExternalSource config dict by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1115
🔧 Enforce type checking in needuml.py by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1116
🔧 Enforce type checking in api/need.py by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1117
🔧 Add better typing for global_options config variable by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1120
🔧 Move dead link need fields to internals by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1119
🔧 Remove usage of hide_status and hide_tags by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1130
🔧 Remove hidden field from extra_options by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1124
🔧 Remove constraints from extra_options by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1123
🔧 Remove use of deprecated needs_extra_options as dict by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1126

New Contributors

@csIcaK made their first contribution in https://github.com/useblocks/sphinx-needs/pull/1081
@big1hc made their first contribution in https://github.com/useblocks/sphinx-needs/pull/964

Full Changelog: https://github.com/useblocks/sphinx-needs/compare/2.0.0...2.1.0

2.0.0

6 months ago

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 https://github.com/useblocks/sphinx-needs/pull/968
Easier Sphinx-Needs docs builds by @danwos in https://github.com/useblocks/sphinx-needs/pull/972
♻️ Change NeedsBuilder format to needs by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/978
👌 Improve sphinx warnings by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/975
📚 DOCS: Always use headless plantuml by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/983
🐛 Fix gantt chart rendering by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/984
👌 Improve plantuml warnings by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/982
🔧 Replace Directive with SphinxDirective by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/986
🧪 Add headless java to test builds by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/988
🧪 Remove all make files in test build folders by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/989
📚 DOCS: Add intersphinx by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/991
🧪 Remove boilerplate from test build conf.py files by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/990
🐛 Fix execute_func by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/994
👌 Improve logging for static file copies by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/992
🔧 Centralise access to sphinx-needs config by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/998
🔧 Centralise sphinx env data access (and add schemas) by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/987
🔧 Add strict typing for sphinx_needs.builder by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1000
🔧 Make NEEDS_CONFIG type safe by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1001
🔧 Make mypy pre-commit hook isolated by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1003
🔀🔧 MERGE: Add strict typing for most sphinx_needs modules by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1002
Bump cypress-io/github-action from 5 to 6 by @dependabot in https://github.com/useblocks/sphinx-needs/pull/981
🐛 Fix adding sections to hidden needs by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/995
🐛 FIX: NeedImport logic by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1006
🐛 Fix creation of need title nodes by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1008
Namnn/need per id json by @nhatnamnguyengtvthcm in https://github.com/useblocks/sphinx-needs/pull/960
📚 DOCS: Add outline of extension logic by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1012
👌 Improve removal of hidden need nodes by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1013
👌 Improve process_constraints by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1015
Fixed extra links example by @piotr-zyskowski-rai in https://github.com/useblocks/sphinx-needs/pull/1016
🔧 Remove unwrap function by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1017
🧪 Add snapshot testing for needs data by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1019
Bump docker/build-push-action from 2 to 5 by @dependabot in https://github.com/useblocks/sphinx-needs/pull/1024
Bump docker/setup-buildx-action from 2 to 3 by @dependabot in https://github.com/useblocks/sphinx-needs/pull/1023
Bump docker/metadata-action from 4 to 5 by @dependabot in https://github.com/useblocks/sphinx-needs/pull/1022
Bump docker/login-action from 1 to 3 by @dependabot in https://github.com/useblocks/sphinx-needs/pull/1021
Bump actions/checkout from 3 to 4 by @dependabot in https://github.com/useblocks/sphinx-needs/pull/1009
🧪 Add snapshot testing for cached doctrees by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1020
👌 Optimize needextend filter_needs usage by @danwos in https://github.com/useblocks/sphinx-needs/pull/1030
👌 From string fix by @danwos in https://github.com/useblocks/sphinx-needs/pull/1031
🐛 Improve logic for process_needextend by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1037
👌 Removing deepcopy by @danwos in https://github.com/useblocks/sphinx-needs/pull/1033
🧪 CI: Make documentation builds fail on warnings by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1005
✨ Add error messages for constraint failures by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1036
🔧 Consolidate needs data post-processing by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1039
♻️ Refactor needs post-processing function signatures by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1040
🔧 Add strict typing for sphinx_needs.functions.functions by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1042
Fix usage of reST syntax in prefix parameter of meta by @sleiner in https://github.com/useblocks/sphinx-needs/pull/1046
👌 Allow needextend to use dynamic functions by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1052
👌 Remove some unnecessary keys from needs.json by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1053
👌 Improve performance of needs builders by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1054
🧪 Testing of JS scripts using Cypress integrated into PyTest by @iSOLveIT in https://github.com/useblocks/sphinx-needs/pull/1051
Add check CI job by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1058
Remove node install from core tests CI by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1057
🧪 Remove plantuml config from test builds conf.py by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1059
⬆️ Update to Sphinx 7 by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1056
🔧 Fix benchmark.yaml CI regression by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1062
🔧 Add remove_node_from_tree utility function by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1063
✨ NEW: needs_reproducible_json config option by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1065
♻️ Make matplotlib dependency optional by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1061
🧪 Add code coverage to CI testing by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1067
🔧 Bump actions/setup-node from 3 to 4 by @dependabot in https://github.com/useblocks/sphinx-needs/pull/1050
🚀 Release v2.0.0 by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1068
🧪 Test README builds in pre-commit by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1069
📚 Pin pydantic version by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1071
🔧 Fix Docker deployment by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/1070

New Contributors

@nhatnamnguyengtvthcm made their first contribution in https://github.com/useblocks/sphinx-needs/pull/960
@piotr-zyskowski-rai made their first contribution in https://github.com/useblocks/sphinx-needs/pull/1016
@sleiner made their first contribution in https://github.com/useblocks/sphinx-needs/pull/1046

Full Changelog: https://github.com/useblocks/sphinx-needs/compare/1.3.0...2.0.0

1.3.0

9 months ago

What's Changed

[877] fix master_doc is not index by @kreuzberger in https://github.com/useblocks/sphinx-needs/pull/878
Bump actions/setup-python from 3 to 4 by @dependabot in https://github.com/useblocks/sphinx-needs/pull/885
Bump markdown-it-py from 2.1.0 to 2.2.0 by @dependabot in https://github.com/useblocks/sphinx-needs/pull/883
Bump actions/cache from 2 to 3 by @dependabot in https://github.com/useblocks/sphinx-needs/pull/886
Bump actions/checkout from 3.2.0 to 3.3.0 by @dependabot in https://github.com/useblocks/sphinx-needs/pull/850
Add missing commas in configuration example by @holmboe in https://github.com/useblocks/sphinx-needs/pull/887
Timing measurement prototype by @danwos in https://github.com/useblocks/sphinx-needs/pull/919
Fix unbounded memory usage in pickle environment by @vpoughonEZ in https://github.com/useblocks/sphinx-needs/pull/912
Guard against "None" body from Github by @Ch3ri0ur in https://github.com/useblocks/sphinx-needs/pull/904
debug measurement fix: Shorter arg string, and build timestamp by @danwos in https://github.com/useblocks/sphinx-needs/pull/921
Removed esbonio for IDE support by @haiyangToAI in https://github.com/useblocks/sphinx-needs/pull/880
CI: Docker build arm images as well... by @cpolzer in https://github.com/useblocks/sphinx-needs/pull/932
🔧 MAINTAIN: Add .nox to gitignore by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/952
Added config allow unsafe filter for filter_func by @haiyangToAI in https://github.com/useblocks/sphinx-needs/pull/949
🔧 Update pre-commit hooks by @chrisjsewell in https://github.com/useblocks/sphinx-needs/pull/956
Bump actions/checkout from 3.3.0 to 3.5.3 by @dependabot in https://github.com/useblocks/sphinx-needs/pull/934
needs: Remove some of the extra IDs in the output by @tim-nordell-nimbelink in https://github.com/useblocks/sphinx-needs/pull/814
Added config option needs_report_dead_links by @haiyangToAI in https://github.com/useblocks/sphinx-needs/pull/937

Full Changelog: https://github.com/useblocks/sphinx-needs/compare/1.2.2...1.3.0

Take a look into the changelog in our docs for more details

1.2.0

9 months ago

What's Changed

Allowing newer versions of jsonschema by @danwos in https://github.com/useblocks/sphinx-needs/pull/848
Initial infra-code for needs2list by @danwos in https://github.com/useblocks/sphinx-needs/pull/855
Adds links_down and meta-data handling to list2need by @danwos in https://github.com/useblocks/sphinx-needs/pull/856
Updated the collapsible containers and minor changes by @iSOLveIT in https://github.com/useblocks/sphinx-needs/pull/857
Attempt to prepare a 1.2.0 release by @bluenote10 in https://github.com/useblocks/sphinx-needs/pull/858

New Contributors

@bluenote10 made their first contribution in https://github.com/useblocks/sphinx-needs/pull/858

Full Changelog: https://github.com/useblocks/sphinx-needs/compare/1.1.1...1.2.0

1.2.1

9 months ago

What's Changed

Put a space after filter string in example usage by @mjsir911 in https://github.com/useblocks/sphinx-needs/pull/869
Installing Java on RTD job by @danwos in https://github.com/useblocks/sphinx-needs/pull/859
Fixed pygls v1.0 module import error by @haiyangToAI in https://github.com/useblocks/sphinx-needs/pull/868
Release preparation 1.2.1 by @danwos in https://github.com/useblocks/sphinx-needs/pull/870

New Contributors

@mjsir911 made their first contribution in https://github.com/useblocks/sphinx-needs/pull/869

Full Changelog: https://github.com/useblocks/sphinx-needs/compare/1.2.0...1.2.1

1.2.2

9 months ago

What's Changed

Allowing not so strict jsonschema: >=3.2.0 by @danwos in https://github.com/useblocks/sphinx-needs/pull/872
Release preparation 1.2.2 by @danwos in https://github.com/useblocks/sphinx-needs/pull/873

Full Changelog: https://github.com/useblocks/sphinx-needs/compare/1.2.1...1.2.2