File tree Expand file tree Collapse file tree 4 files changed +47
-2
lines changed
Expand file tree Collapse file tree 4 files changed +47
-2
lines changed Original file line number Diff line number Diff line change 1+ needs-config-writer
2+ ===================
3+
4+ Sphinx-Needs can be fully configured via ``conf.py ``, but can also load configuration from a
5+ ``ubproject.toml `` file. This file can be created and updated automatically via the
6+ ``needs-config-writer `` Sphinx extension.
7+
8+ Many Sphinx projects want to generate a part of the Sphinx-Needs configuration automatically.
9+ Tools like ubCode / ubc require a declarative format to ingest configuration.
10+ This extension tries to bridge the gap between Sphinx's dynamic Python configuration and
11+ the need for a static configuration file.
12+
113**Complete documentation **: https://needs-config-writer.useblocks.com
Original file line number Diff line number Diff line change @@ -9,6 +9,39 @@ Changelog
99 Unreleased
1010 ----------
1111
12+ .. _`release:0.2.1` :
13+
14+ 0.2.1
15+ -----
16+
17+ :Released: 28.10.2025
18+ :Full Changelog: `v0.2.0...v0.2.1 <https://github.com/useblocks/needs-config-writer/compare/0.2.0...76b32b4 >`__
19+
20+ This releases adds quality-of-life improvements and minor fixes.
21+
22+ - π Restructure docs (:pr: `10 ` and :pr: `11 `)
23+
24+ A ``Motivation `` page was added to explain about problems and use-cases.
25+ Also an example for complex setups was added to illustrate how this extension
26+ can be used in real-world scenarios.
27+
28+ - π§ Return metadata in setup (:pr: `12 `)
29+
30+ The extension now returns metadata such as version and whether it can be run in parallel
31+ in the ``setup() `` call.
32+
33+ - π New config needscfg_exclude_vars (:pr: `13 `)
34+
35+ A new configuration option ``needscfg_exclude_vars `` was added to customize
36+ which Sphinx-Needs configuration variables are excluded from the exported TOML file.
37+ See :ref: `excluded_configs ` for details.
38+
39+ - β¨ Merge additional TOML files (:pr: `14` `)
40+
41+ A new configuration option ``needscfg_merge_toml_files `` was added to specify
42+ additional TOML files to merge into the exported ``ubproject.toml ``.
43+ This allows to combine static configuration files with the dynamically generated one.
44+
1245.. _`release:0.2.0` :
1346
14470.2.0
Original file line number Diff line number Diff line change 11"""Sphinx extension to write Sphinx-Needs config to ubproject.toml."""
22
3- __version__ = "0.2.0 "
3+ __version__ = "0.2.1 "
44
55
66def setup (app ):
Original file line number Diff line number Diff line change @@ -4,7 +4,7 @@ build-backend = "flit_core.buildapi"
44
55[project ]
66name = " needs-config-writer"
7- version = " 0.2.0 "
7+ version = " 0.2.1 "
88description = " Sphinx extension to write Sphinx-Needs config to ubproject.toml"
99readme = " README.rst"
1010urls.Repository = " https://github.com/useblocks/needs-config-writer"
You canβt perform that action at this time.
0 commit comments