Releases: useblocks/sphinx-needs
v6.3.0
What's Changed
- 👌 Relative paths from toml configuration by @chrisjsewell in #1589
- 👌 Ensure
extra_linksschemacontains item type by @chrisjsewell in #1595 - 👌 Validate all schemas compile during config resolution by @chrisjsewell in #1596
- ♻️ Remove typeguard dependency by @chrisjsewell in #1597
- ⬆️ Support Python 3.14 by @chrisjsewell in #1598
- 📚 Fix typo in tutorial documentation by @dskkato in #1591
- [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci[bot] in #1586
New Contributors
Full Changelog: 6.2.0...6.3.0
6.2.0
What's Changed
- 🧪 Fix schema benchmark tests by @ubmarco in #1577
- 🧪 Improve schema process benchmarking by @chrisjsewell in #1579
- 🔧 Reduce nested functions in
get_ontology_warningsby @chrisjsewell in #1578 - 👌 Improve schema validation performance (pre-compute validators) by @chrisjsewell in #1581
- 👌 Improve schema validation performance (use jsonschema-rs) by @chrisjsewell in #1582
- 👌 Improve schema validation performance (improve reduce_needs) by @chrisjsewell in #1583
- 👌 Improve schema validation performance (cache recursive validators) by @chrisjsewell in #1584
- [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci[bot] in #1421
- 🚀 Release v6.2.0 by @chrisjsewell in #1585
Full Changelog: 6.1.1...6.2.0
v6.1.1
What's Changed
- 👌 Allow . in schema regex by @ubmarco in #1568
- 🐛 Fix schema network type injection by @ubmarco in #1570
- 🐛 needs.json for nullable fields by @ubmarco in #1571
- 🔧 Remove mutable global variables by @chrisjsewell in #1575
- ✨ Add
needs_schema_validation_enabledconfiguration by @chrisjsewell in #1574 - ✨ Add
allow_type_coercionconfiguration for external/importneeds.jsonreads by @chrisjsewell in #1573
Full Changelog: 6.1.0...6.1.1
v6.1.0
What's Changed
- 🐛 Fix schema rule severity by @ubmarco in #1535
- 📚 Co-locate dynamic and variant function docs by @chrisjsewell in #1544
- 🧪 Add snapshot test for field schema by @chrisjsewell in #1545
- 🔧 Derive core
FieldSchemafromNeedsCoreFieldsby @chrisjsewell in #1546 - 👌 Make
incoming/outgoingkeys optional inneeds_extra_linksby @chrisjsewell in #1548 - 🔧 Removed unused code by @chrisjsewell in #1550
- 📚 Enable link to full schema example by @ubmarco in #1538
- 🔧 Variable typo by @ubmarco in #1555
- 📚 Improve schema docs by @ubmarco in #1554
- 📚 Fix linkchecks by @ubmarco in #1556
- 🔧 Run new ubc action on docs by @ubmarco in #1541
- 👌 Improve schema severity handling by @ubmarco in #1561
- ♻️ Early resolution of schema_debug_path by @ubmarco in #1563
- 🚀 Release v6.1.0 by @ubmarco in #1565
Full Changelog: 6.0.1...6.1.0
v6.0.1
What's Changed
- 📚 Add release labels to changelog by @ubmarco in #1523
- 🔧 Improve error for variant options by @ubmarco in #1524
- 🔧 Fix schema json missing exc message by @ubmarco in #1526
- 👌 Add schema to add_extra_option by @ubmarco in #1527
- 🐛 Fix name error schema_path_contains by @ubmarco in #1530
- 🐛 Inject build_tags to variant filter strings by @ubmarco in #1531
- 🚀 Release v6.0.1 by @ubmarco in #1532
Full Changelog: 6.0.0...6.0.1
v6.0.0
What's Changed
- 👌 Re-allow dynamic functions for
layoutfield by @chrisjsewell in #1423 - 🔧 Centralise allowed variant core need fields by @chrisjsewell in #1424
- 🐛 Warn on dynamic function with surrounding text by @chrisjsewell in #1426
- 🔧 Allow pre/post template
global_optionsby @chrisjsewell in #1428 - ✨ Add
is_importneed field by @chrisjsewell in #1429 - 📚 update tox version to py39 by @ubmarco in #1438
- 🔧 Use ubuntu-latest in CI by @ubmarco in #1439
- 🔧 Added yamlfmt pre-commit by @ubmarco in #1446
- 🐛 Fix cyclic imports by @ubmarco in #1443
- 🔧 benchmark group non win32 by @ubmarco in #1450
- ⬆️ Drop Sphinx<7.4, test against Python 3.13 by @ubmarco in #1447
- 🔧 Allow template global_options by @chrisjsewell in #1454
- Allow
collapseandhideinneeds_global_optionsby @chrisjsewell in #1456 - 👌 Reset directive option specs at start of build by @ubmarco in #1448
- ⬆️ Drop Python 3.9 by @ubmarco in #1468
- 👌 Improve need part processing by @chrisjsewell in #1469
- 📚 Fix escape sequences by @ubmarco in #1470
- 📚 Format configuration.rst by @chrisjsewell in #1473
- ✨ Schema validation v2 by @ubmarco in #1467
- 📚 Clarify c.this_doc() for needextend by @ubmarco in #1475
‼️ Disallowadd_extra_optionoverriding an internal field by @chrisjsewell in #1477‼️ Improve needs default field application (via needs_global_options) by @chrisjsewell in #1478- ♻️ Lazily assess directive options by @chrisjsewell in #1482
- 🔧 Split import item filtering to separate function by @chrisjsewell in #1484
- ♻️ Store needs as
NeedItem/NeedPartItem, rather than standarddictby @chrisjsewell in #1485 - ♻️ Set some core need fields to nullable by @chrisjsewell in #1488
- 🐛 Fix: disallow need variants for list type fields by @chrisjsewell in #1489
- ♻️ split
NeedIteminternal data into core, extras, links and backlinks by @chrisjsewell in #1490 - ♻️ split off
sourcefields inNeedIteminternal data by @chrisjsewell in #1491 - ♻️ Auto-compute certain need fields by @chrisjsewell in #1496
- 📚 Fix needs_extra_links name by @HolgerPeters in #1501
- 👌 Capture more information about modifications on
NeedItemby @chrisjsewell in #1502 - 🔧 Improve storage of constraint results on
NeedItemby @chrisjsewell in #1504 - ♻️ Exclude
is_need/is_partfromneeds.jsonoutput by @chrisjsewell in #1505 - 🔧 Improve storage of content generation on
NeedItemby @chrisjsewell in #1506 - 🧪 Improve test for need parts by @chrisjsewell in #1507
- ♻️ Improve storage of part data on NeedItem by @chrisjsewell in #1509
- 👌 Write schema violations into a JSON file by @iSOLveIT in #1503
- Always generate schema violations.json report file by @iSOLveIT in #1511
- 🐛 Avoid leaking auth credentials for ext. need warnings by @cedossan in #1512
- 🔧 Add
DynamicFunctionParseddataclass by @chrisjsewell in #1514 - 🔧 Add
VariantFunctionParseddataclass by @chrisjsewell in #1515 ‼️ remove parsing of deprecatedneeds_global_optionsformat by @chrisjsewell in #1517- 🧪 Move to snapshot testing for test_schema by @chrisjsewell in #1519
- ♻️ Allow for typed
needs_extra_optionsfields by @chrisjsewell in #1516 - ♻️ Warn for missing needimport files by @PhilipPartsch in #1510
- 🔧 Improve plantuml check + add tests by @ubmarco in #1521
- 🚀 Release v6.0.0 by @ubmarco in #1522
New Contributors
- @HolgerPeters made their first contribution in #1501
- @cedossan made their first contribution in #1512
Full Changelog: 5.1.0...6.0.0
v5.1.0
What's Changed
- ♻️ Improve validation and docs for
needs_global_optionsby @chrisjsewell in #1410 - ♻️ Change
needs_global_optionsformat by @chrisjsewell in #1413
Full Changelog: 5.0.0...5.1.0
v5.0.0
What's Changed
-
✨ Add
c.this_doc()check forneedextendfilters by @chrisjsewell in #1393 -
✨ Extend
c.this_doc()to all directives withfilteroption by @chrisjsewell in #1405 -
♻️ Remove back link manipulation from
needextendby @chrisjsewell in #1386 -
🔧 Synchronize list splitting behaviour in need and needextend directives by @chrisjsewell in #1385
-
👌 Add type warnings of extra options in external/import reads by @chrisjsewell in #1389
-
🔧 Centralise extendable core need fields by @chrisjsewell in #1388
-
♻️ Don't process dynamic functions on internal need fields by @chrisjsewell in #1387
-
♻️ Make
needextendargument declarative by @chrisjsewell in #1391 -
🔧 Remove
constraints_passed/constraints_resultsdirective options by @chrisjsewell in #1396 -
♻️ Remove
deletefrom internal needs andneeds.jsonby @chrisjsewell in #1347 -
♻️ Remove
full_titleneed field and only trim generated titles by @chrisjsewell in #1407 -
🔧 Deprecate use of dynamic functions in need type fields by @chrisjsewell in #1406
-
🐛 Fix CSS for need table colors by @chrisjsewell in #1403
-
📚 clarify
needimportargument format by @chrisjsewell in #1384
Full Changelog: 4.2.0...5.0.0
4.2.0
What's Changed
- 🔧 Add
linenoto default output ofneeds.jsonby @chrisjsewell in #1346 - 🔧 Replace poetry with flit/uv by @chrisjsewell in #1355
- 🔧 Release needs data mutation lock at end of process by @chrisjsewell in #1359
- Allow filter-func in need-pie to have multiple dots in the import path. by @Aymen-Soussi-01 in #1373
- Fix typo in layout_styles.rst by @interifter in #1374
- 🐛 Fix: make external paths relative to
confdir, notsrcdirby @chrisjsewell in #1378 - ✨ Add
needs_import_keysconfiguration by @chrisjsewell in #1379
New Contributors
- @Aymen-Soussi-01 made their first contribution in #1373
- @interifter made their first contribution in #1374
Full Changelog: 4.1.0...4.2.0
v4.1.0
What's Changed
- ✨ Add
needs_from_tomlconfiguration by @chrisjsewell in #1337 - ✨ Allow configuring description of extra option by @chrisjsewell in #1338
- 🐛 FIX needflow graphviz links by @chrisjsewell in #1339
- 🐛 Fix plantuml top-level import by @chrisjsewell in #1328
- ♻️ Improve access to dynamic configs: extra_options, functions, warnings by @chrisjsewell in #1332
- 🔧 Merge defaults into config earlier by @chrisjsewell in #1341
- 🔧 Remove some internal fields from needs layout by @chrisjsewell in #1330
- 📚 Docs: Fix API package by @ubmarco in #1327
Full Changelog: 4.0.0...4.1.0