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
2 changes: 2 additions & 0 deletions docs/source/components/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,8 @@ Default: **cpp**
[src_trace.projects.project_name]
comment_type = "c"

.. _source_dir:

src_dir
~~~~~~~

Expand Down
29 changes: 26 additions & 3 deletions docs/source/development/change_log.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,29 @@
Changelog
=========

.. _release:0.1.2:

0.1.2
Comment thread
juiwenchen marked this conversation as resolved.
-----

: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 <source_dir>` in multiple
project configurations point at different locations.

.. _release:0.1.1:

0.1.1
-----

Expand All @@ -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
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 = "0.1.1"
version = "0.1.2"
description = "Fast Source Code Traceability for Sphinx-Needs"
authors = [{ name = "team useblocks", email = "info@useblocks.com" }]
maintainers = [
Expand Down