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 69ed3d6..6d38699 100644 --- a/docs/source/development/change_log.rst +++ b/docs/source/development/change_log.rst @@ -3,6 +3,29 @@ Changelog ========= +.. _release:0.1.2: + +0.1.2 +----- + +:Released: 16.07.2025 + +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. + +- 🐛 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: + 0.1.1 ----- @@ -12,6 +35,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 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 = [