File tree Expand file tree Collapse file tree 4 files changed +44
-5
lines changed
Expand file tree Collapse file tree 4 files changed +44
-5
lines changed Original file line number Diff line number Diff line change 2424# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
2525
2626extensions = [
27+ "sphinx.ext.extlinks" ,
2728 "sphinx_needs" ,
2829]
2930
6970
7071# Sphinx-Needs configuration
7172needs_from_toml = "ubproject.toml"
73+
74+ extlinks = {
75+ "pr" : ("https://github.com/useblocks/needs-config-writer/pull/%s" , "PR #%s" ),
76+ "issue" : (
77+ "https://github.com/useblocks/needs-config-writer/issues/%s" ,
78+ "issue #%s" ,
79+ ),
80+ }
Original file line number Diff line number Diff line change 33Changelog
44=========
55
6- .. _unreleased :
6+ ..
7+ .. _unreleased:
78
8- Unreleased
9- ----------
9+ Unreleased
10+ ----------
11+
12+ .. _`release:0.2.0` :
13+
14+ 0.2.0
15+ -----
16+
17+ :Released: 28.10.2025
18+ :Full Changelog: `v0.1.0...v0.2.0 <https://github.com/useblocks/needs-config-writer/compare/0.1.0...e457d2f >`__
19+
20+ This release reduce the complexity of content comparison and improves the configuration.
21+ It's not backwards compatible as most of the configuration changed. Please check the updated documentation.
22+
23+ - β»οΈ Remove hash based comparison (:pr: `8 `)
24+
25+ The configuration ``needscfg_use_hash `` was renamed to :ref: `config_warn_on_diff `.
26+ Hashing is not required as the content can be compared directly.
27+ This is simpler with less config and less dependencies.
28+ Default is ``True ``.
29+
30+ :ref: `config_overwrite ` now checks in all cases whether to overwrite differing files.
31+ Default is ``False `` to prevent accidental overwrites.
32+
33+ The configuration ``needscfg_write_defaults `` was renamed to :ref: `config_write_all `
34+ to be more explicit about what it does. If enabled, all known Sphinx-Needs configuration is written,
35+ including defaults and not only explicitly set values.
36+ Default is ``False ``.
37+
38+ Fix sorting of ``needs_extra_options `` which maybe given as ``list[str] `` or ``list[dict] ``.
39+ For the latter case it is sorted by the ``name `` key.
1040
1141.. _`release:0.1.0` :
1242
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.1 .0"
3+ __version__ = "0.2 .0"
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.1 .0"
7+ version = " 0.2 .0"
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