Changelog¶

1.1.0¶

✨ Added C# parser for analyse module.

Need ID references and marked RST blocks can be extracted from C# source files. The comments styles supported are:(//, /* */, ///)
✨ Added YAML parser for analyse module.

Need ID references can be extracted from YAML files. The supported comment style is # as well as inline comment style, e.g. key: value # comment.
👌 Directive src-trace itself does not create need items anymore and only generate need items from the one-line need definition in the given source.

The need item is removed because:
- It has no use cases so far.
- It creates extra need items users may not actually want in their documentation
- It creates errors with some Sphinx-Needs configurations, e.g., when need_id_required or needs_statuses is defined.

🐛 Replace absolute path with relative path to fix local-url not working on the non-local environment
🐛 Add more file extensions of C/C++ for SourceDiscover

✨ Added a new analyse CLI command and corresponding API.

The analyse command parses source files (Python, C/C++) and extracts markers from comments. It can extract three types of markers, as documented in the analyse section:
- One-line need definitions
- Need ID references
- Marked RST blocks
The extracted markers and their metadata are saved to a JSON file for further processing.
✨ Added a new write rst CLI command.

The write rst command writes a reStructuredText file with needextend directive from the extracted markers generated by analyse. The generated RST can be included in the Sphinx documentation to create the source code links in the existing needs
👌 Replaced virtual_docs with the new analyse module.

The virtual_docs feature, which handled one-line need definitions (OneLineCommentStyle), has been migrated into the new analyse module and removed from the core. The caching feature of virtual_docs is temporarily removed and may be reintroduced later.
👌 Updated the src-trace Sphinx directive.

The src-trace directive now uses the new analyse API instead of the old virtual_docs one.
👌 Unified configuration in TOML

The configuration for src-trace directive defined in TOML is now compatible with the new analyse module.

🐛 Apply default configuration values 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 src_dir in multiple project configurations point at different locations.

Initial release of Sphinx-CodeLinks

This version features: