Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 48 additions & 5 deletions docs/source/development/change_log.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,60 @@
Changelog
=========

Upcoming
--------
.. _`release:1.3.0`:

1.3.0
-----

:Released: 20.06.2026

New and Improved
................

- ⬆️ Support and test sphinx-needs v5-8
- 📚 Documented C# language support in ``features.rst``
- 🧪 Added Sphinx integration test for C# source files
- ✨ Added Go parser for the ``analyse`` module.

Need ID references and one-line need definitions can now be extracted from Go source files.
The supported comment styles are ``//`` and ``/* */``.

- ✨ Added JSONC language support for the ``analyse`` module.

Comments in JSONC files are now parsed for need ID references and one-line need definitions.
``.json`` files are also checked when they begin with a comment (see jsonc.org).

- 👌 Replaced ``gitignore-parser`` with ``ignore-python`` for source discovery.

This adds native nested ``.gitignore`` support, improves performance, and brings behavioral
parity with ubCode. A per-project ``follow_links`` configuration option was also added.

- ⬆️ Support and test Sphinx-Needs v5-8.
- ⬆️ Allow Sphinx 9.
- 📚 Documented C# language support in ``features.rst``.
- 🧪 Added a Sphinx integration test for C# source files.

Fixes
.....

- 🐛 Register Sphinx-Needs fields with a typed schema.

The ``project``, ``file``, ``directory`` and URL fields are now registered with a typed
(string) schema, so they no longer trigger schema violations on needs that do not set them
when strict Sphinx-Needs schema validation is enabled.

- 🐛 Do not mutate the ``rebuild='env'`` ``src_trace_projects`` configuration during builds.

Incremental Sphinx builds no longer re-read every document on each run.

- 🐛 Route ``analyse`` logging through the active environment instead of installing a stderr
handler at import time.

Routine INFO progress no longer goes to stderr unconditionally, and importing the package no
longer forces a logging handler onto consumers.

- 🐛 Validate field default ordering in the oneline configuration.

A required field defined after a field with a default is now reported as an error instead of
being silently skipped.

.. _`release:1.2.0`:

1.2.0
Expand Down
1 change: 0 additions & 1 deletion docs/source/development/roadmap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ Source Code Parsing

- Introduce a configurable option to strip leading characters (e.g., ``*``) from commented RST blocks.
- Enrich tagged scopes with additional metadata.
- ✅ Nested ``.gitignore`` files are now supported (implemented via ``ignore-python``).

Defining Needs in Source Code
-----------------------------
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "sphinx-codelinks"
version = "1.2.0"
version = "1.3.0"
description = "Fast Source Code Traceability for Sphinx-Needs"
authors = [{ name = "team useblocks", email = "info@useblocks.com" }]
maintainers = [
Expand Down
Loading