From 377922abfb31b2527c043697c68ff0410dfa058a Mon Sep 17 00:00:00 2001 From: "jui-wen.chen" Date: Wed, 16 Jul 2025 09:10:21 +0200 Subject: [PATCH 1/3] release 0.1.2 --- docs/source/development/change_log.rst | 10 ++++++++++ pyproject.toml | 2 +- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/source/development/change_log.rst b/docs/source/development/change_log.rst index 69ed3d6..a30514a 100644 --- a/docs/source/development/change_log.rst +++ b/docs/source/development/change_log.rst @@ -3,6 +3,16 @@ Changelog ========= +0.1.2 +----- + +:Released: 16.07.2025 + +Fixed: + +- Applying default configs when not given +- ``local-url`` in multi-projects + 0.1.1 ----- diff --git a/pyproject.toml b/pyproject.toml index 67e4495..e27fecb 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "sphinx-codelinks" -version = "0.1.1" +version = "0.1.2" description = "Fast Source Code Traceability for Sphinx-Needs" authors = [{ name = "team useblocks", email = "info@useblocks.com" }] maintainers = [ From 9d40f6a6c217e7c95b351043b4bc136b58d236f9 Mon Sep 17 00:00:00 2001 From: "jui-wen.chen" Date: Wed, 16 Jul 2025 10:15:04 +0200 Subject: [PATCH 2/3] updated according to the review --- docs/source/components/configuration.rst | 2 ++ docs/source/development/change_log.rst | 22 ++++++++++++++++------ 2 files changed, 18 insertions(+), 6 deletions(-) diff --git a/docs/source/components/configuration.rst b/docs/source/components/configuration.rst index 599f124..161bcf1 100644 --- a/docs/source/components/configuration.rst +++ b/docs/source/components/configuration.rst @@ -164,6 +164,8 @@ Default: **cpp** [src_trace.projects.project_name] comment_type = "c" +.. _source_dir: + src_dir ~~~~~~~ diff --git a/docs/source/development/change_log.rst b/docs/source/development/change_log.rst index a30514a..16435c1 100644 --- a/docs/source/development/change_log.rst +++ b/docs/source/development/change_log.rst @@ -3,15 +3,25 @@ Changelog ========= +.. _release:0.1.2: + 0.1.2 ----- :Released: 16.07.2025 -Fixed: +Fixes +..... + +- 🐛 Applying default configuration value when not given + +When a user does not specify certain configuration options, the extension will automatically use predefined default +values, allowing users to get started quickly without needing to customize every option. +Users can override these defaults by explicitly providing their own configuration values. + +- 🐛 Local links between docs and one-line need definitions work correctly, when :ref:`src_dir ` in multiple project configurations point at different locations. -- Applying default configs when not given -- ``local-url`` in multi-projects +.. _release:0.1.1: 0.1.1 ----- @@ -22,6 +32,6 @@ Initial release of ``Sphinx-CodeLinks`` This version features: -- Sphinx Directive ``src-trace`` -- Virtual Docs and Source Discovery CLI -- One-line comment to define a ``Sphinx-Needs`` need item +- ✨ Sphinx Directive ``src-trace`` +- ✨ Virtual Docs and Source Discovery CLI +- ✨ One-line comment to define a ``Sphinx-Needs`` need item From 6bc770c86812a4721125ea7f3dd91bca82d7f9d4 Mon Sep 17 00:00:00 2001 From: juiwenchen <46341773+juiwenchen@users.noreply.github.com> Date: Wed, 16 Jul 2025 11:40:16 +0200 Subject: [PATCH 3/3] Update docs/source/development/change_log.rst Co-authored-by: Marco Heinemann --- docs/source/development/change_log.rst | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/source/development/change_log.rst b/docs/source/development/change_log.rst index 16435c1..6d38699 100644 --- a/docs/source/development/change_log.rst +++ b/docs/source/development/change_log.rst @@ -15,11 +15,14 @@ Fixes - 🐛 Applying default configuration value when not given -When a user does not specify certain configuration options, the extension will automatically use predefined default -values, allowing users to get started quickly without needing to customize every option. -Users can override these defaults by explicitly providing their own configuration values. + When a user does not specify certain configuration options, the extension will automatically use predefined default + values, allowing users to get started quickly without needing to customize every option. + Users can override these defaults by explicitly providing their own configuration values. -- 🐛 Local links between docs and one-line need definitions work correctly, when :ref:`src_dir ` in multiple project configurations point at different locations. +- 🐛 Fix local links for multi project configurations + + Local links between docs and one-line need definitions work correctly, when :ref:`src_dir ` in multiple + project configurations point at different locations. .. _release:0.1.1: