Traceability

Implementation

Implementation: Guard the optional libclang dependency with an install hint IMPL_PREPROC_6

local-url: ../src/sphinx_codelinks/analyse/preproc/loader#L20 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/analyse/preproc/loader.py#L20 links outgoing: FE_PREPROC

Implementation: Support C and C++ style comments IMPL_C_1

local-url: ../src/sphinx_codelinks/config#L23 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/config.py#L23 links outgoing: FE_C_SUPPORT, FE_CPP

Implementation: Python Scope Node Types IMPL_PY_2

local-url: ../src/sphinx_codelinks/analyse/utils#L24 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/analyse/utils.py#L24 links outgoing: FE_PY

Implementation: Support Python style comments IMPL_PY_1

local-url: ../src/sphinx_codelinks/config#L25 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/config.py#L25 links outgoing: FE_PY

Implementation: C and C++ Scope Node Types IMPL_C_2

local-url: ../src/sphinx_codelinks/analyse/utils#L26 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/analyse/utils.py#L26 links outgoing: FE_C_SUPPORT, FE_CPP

Implementation: Support Go style comments IMPL_GO_2

local-url: ../src/sphinx_codelinks/config#L28 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/config.py#L28 links outgoing: FE_GO

Implementation: Rust Scope Node Types IMPL_RUST_2

local-url: ../src/sphinx_codelinks/analyse/utils#L29 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/analyse/utils.py#L29 links outgoing: FE_RUST

Implementation: Support Rust style comments IMPL_RUST_1

local-url: ../src/sphinx_codelinks/source_discover/config#L30 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/source_discover/config.py#L30 links outgoing: FE_RUST

Implementation: Support Go style comments IMPL_GO_1

local-url: ../src/sphinx_codelinks/source_discover/config#L32 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/source_discover/config.py#L32 links outgoing: FE_GO

Implementation: Support JSONC style comments IMPL_JSONC_1

local-url: ../src/sphinx_codelinks/source_discover/config#L34 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/source_discover/config.py#L34 links outgoing: FE_JSONC

Implementation: Support Bash style comments IMPL_BASH_1

local-url: ../src/sphinx_codelinks/source_discover/config#L36 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/source_discover/config.py#L36 links outgoing: FE_BASH

Implementation: Discover compile_commands.json by walking up from the source file IMPL_PREPROC_3

local-url: ../src/sphinx_codelinks/analyse/preproc/compile_db#L38 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/analyse/preproc/compile_db.py#L38 links outgoing: FE_PREPROC

Implementation: Go Scope Node Types IMPL_GO_4

local-url: ../src/sphinx_codelinks/analyse/utils#L38 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/analyse/utils.py#L38 links outgoing: FE_GO

Implementation: Bash Scope Node Types IMPL_BASH_2

local-url: ../src/sphinx_codelinks/analyse/utils#L45 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/analyse/utils.py#L45 links outgoing: FE_BASH

Implementation: Drop comments inside inactive preprocessor branches IMPL_PREPROC_2

local-url: ../src/sphinx_codelinks/analyse/preproc/libclang_parser#L61 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/analyse/preproc/libclang_parser.py#L61 links outgoing: FE_PREPROC

Implementation: Source code file discovery with gitignore support IMPL_DISC_1

local-url: ../src/sphinx_codelinks/source_discover/source_discover#L64 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/source_discover/source_discover.py#L64 links outgoing: FE_CLI_DISCOVER, FE_DISCOVERY links incoming: TEST_DISC_1, TEST_MISSING_FILE_1, TEST_OUTSIDE_ROOTS_1

Implementation: Go comment query for tree-sitter IMPL_GO_3

local-url: ../src/sphinx_codelinks/analyse/utils#L72 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/analyse/utils.py#L72 links outgoing: FE_GO

Implementation: Bash comment query for tree-sitter IMPL_BASH_3

local-url: ../src/sphinx_codelinks/analyse/utils#L77 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/analyse/utils.py#L77 links outgoing: FE_BASH

Implementation: Register the URL fields' string links at config-inited IMPL_URL_LINKS_1

local-url: ../src/sphinx_codelinks/sphinx_extension/string_links#L95 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/sphinx_extension/string_links.py#L95 links outgoing: FE_DEF links incoming: TEST_URL_LINKS_1

Implementation: One-line comment parser for traceability markers IMPL_OLP_1

local-url: ../src/sphinx_codelinks/analyse/oneline_parser#L98 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/analyse/oneline_parser.py#L98 links outgoing: FE_CMT, FE_DEF links incoming: TEST_CONF_1, TEST_OLP_1, TEST_ONELINE_WARNINGS_1

Implementation: Resolve per-file compiler flags from the compilation database IMPL_PREPROC_4

local-url: ../src/sphinx_codelinks/analyse/preproc/compile_db#L107 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/analyse/preproc/compile_db.py#L107 links outgoing: FE_PREPROC

Implementation: CLI command to analyse source code and extract traceability markers IMPL_CLI_ANALYZE

local-url: ../src/sphinx_codelinks/cmd#L107 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/cmd.py#L107 links outgoing: FE_CLI_ANALYZE links incoming: TEST_CLI_1

Implementation: Tree-sitter parser initialization for multiple languages IMPL_LANG_1

local-url: ../src/sphinx_codelinks/analyse/utils#L108 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/analyse/utils.py#L108 links outgoing: FE_BASH, FE_C_SUPPORT, FE_CPP, FE_GO, FE_JSONC, FE_PY, FE_RUST, FE_YAML links incoming: TEST_LANG_1

Implementation: Parse headers standalone from configured defines and includes IMPL_PREPROC_5

local-url: ../src/sphinx_codelinks/analyse/preproc/compile_db#L128 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/analyse/preproc/compile_db.py#L128 links outgoing: FE_PREPROC

Implementation: JSONC .json files require a leading comment IMPL_JSONC_3

local-url: ../src/sphinx_codelinks/source_discover/source_discover#L152 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/source_discover/source_discover.py#L152 links outgoing: FE_JSONC

Implementation: Comment extraction from source code using tree-sitter IMPL_EXTR_1

local-url: ../src/sphinx_codelinks/analyse/utils#L156 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/analyse/utils.py#L156 links outgoing: FE_DEF links incoming: TEST_LANG_1

Implementation: CLI command to discover source files recursively with gitignore support IMPL_CLI_DISCOVER

local-url: ../src/sphinx_codelinks/cmd#L232 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/cmd.py#L232 links outgoing: FE_CLI_DISCOVER links incoming: TEST_CLI_1

Implementation: Extract traceability objects with the preprocessor-aware libclang engine IMPL_PREPROC_1

local-url: ../src/sphinx_codelinks/analyse/analyse#L279 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/analyse/analyse.py#L279 links outgoing: FE_PREPROC

Implementation: CLI command to generate needextend RST file from extracted markers IMPL_CLI_WRITE

local-url: ../src/sphinx_codelinks/cmd#L291 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/cmd.py#L291 links outgoing: FE_CLI_WRITE links incoming: TEST_CLI_1, TEST_WRITE_1

Implementation: JSONC comment-to-structure association IMPL_JSONC_2

local-url: ../src/sphinx_codelinks/analyse/utils#L294 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/analyse/utils.py#L294 links outgoing: FE_JSONC links incoming: TEST_ANA_2

Implementation: Extract need ID references from code comments IMPL_LNK_1

local-url: ../src/sphinx_codelinks/analyse/analyse#L366 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/analyse/analyse.py#L366 links outgoing: FE_LNK links incoming: TEST_ANA_1, TEST_ANA_2, TEST_ANA_ORDER_1, TEST_CONFIG_ONLY_REFS_1, TEST_EXT_1, TEST_NEED_ID_REF_1, TEST_NEED_ID_REFS_1, TEST_NEED_ID_REFS_ATTACH_1, TEST_NEED_ID_REFS_CONFIG_1, TEST_ONE_NEED_PER_ID_1, TEST_REDISCOVERY_1, TEST_SOURCE_PAGES_1

Implementation: Parse multi-line need blocks in a comment run IMPL_MLN_2

local-url: ../src/sphinx_codelinks/analyse/multiline_parser#L396 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/analyse/multiline_parser.py#L396 links outgoing: FE_MULTILINE_NEEDS links incoming: TEST_MLN_1

Implementation: Extract one-line traceability needs from comments IMPL_ONE_1

local-url: ../src/sphinx_codelinks/analyse/analyse#L511 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/analyse/analyse.py#L511 links outgoing: FE_CMT, FE_DEF links incoming: TEST_ANA_1, TEST_ANA_2, TEST_ANA_ORDER_1, TEST_EXT_1

Implementation: Extract multi-line needs from comment runs IMPL_MLN_1

local-url: ../src/sphinx_codelinks/analyse/analyse#L573 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/analyse/analyse.py#L573 links outgoing: FE_MULTILINE_NEEDS links incoming: TEST_ANA_1, TEST_ANA_2, TEST_CONF_1, TEST_MLN_1

Testing

Test: Test suite for source code analysis and marker extraction TEST_ANA_1

local-url: ../tests/test_analyse#L1 remote-url: packages/sphinx-codelinks/tests/test_analyse.py#L1 links outgoing: IMPL_LNK_1, IMPL_MLN_1, IMPL_ONE_1

Test: Test suite for source analysis configuration validation TEST_CONF_1

local-url: ../tests/test_analyse_config#L1 remote-url: packages/sphinx-codelinks/tests/test_analyse_config.py#L1 links outgoing: IMPL_MLN_1, IMPL_OLP_1

Test: Test that line numbers stay exact far past line 256 TEST_ANA_2

local-url: ../tests/test_analyse_long_source#L1 remote-url: packages/sphinx-codelinks/tests/test_analyse_long_source.py#L1 links outgoing: IMPL_JSONC_2, IMPL_LNK_1, IMPL_MLN_1, IMPL_ONE_1

Test: Test suite for the source order of marked content on one row TEST_ANA_ORDER_1

local-url: ../tests/test_analyse_order#L1 remote-url: packages/sphinx-codelinks/tests/test_analyse_order.py#L1 links outgoing: IMPL_LNK_1, IMPL_ONE_1

Test: Test suite for tree-sitter parsing utilities and language support TEST_LANG_1

local-url: ../tests/test_analyse_utils#L1 remote-url: packages/sphinx-codelinks/tests/test_analyse_utils.py#L1 links outgoing: IMPL_EXTR_1, IMPL_LANG_1

Test: Test suite for CLI commands including analyse, discover, and write TEST_CLI_1

local-url: ../tests/test_cmd#L1 remote-url: packages/sphinx-codelinks/tests/test_cmd.py#L1 links outgoing: IMPL_CLI_ANALYZE, IMPL_CLI_DISCOVER, IMPL_CLI_WRITE

Test: Test suite for references of projects without a src-trace directive TEST_CONFIG_ONLY_REFS_1

local-url: ../tests/test_config_only_refs#L1 remote-url: packages/sphinx-codelinks/tests/test_config_only_refs.py#L1 links outgoing: IMPL_LNK_1

Test: Test suite for a src-trace file scope naming no file TEST_MISSING_FILE_1

local-url: ../tests/test_missing_file_scope#L1 remote-url: packages/sphinx-codelinks/tests/test_missing_file_scope.py#L1 links outgoing: IMPL_DISC_1

Test: Test suite for multi-line need runs and prefixes and grammar TEST_MLN_1

local-url: ../tests/test_multiline_parser#L1 remote-url: packages/sphinx-codelinks/tests/test_multiline_parser.py#L1 links outgoing: IMPL_MLN_1, IMPL_MLN_2

Test: Test suite for the need id reference record TEST_NEED_ID_REF_1

local-url: ../tests/test_need_id_ref_record#L1 remote-url: packages/sphinx-codelinks/tests/test_need_id_ref_record.py#L1 links outgoing: IMPL_LNK_1

Test: Test suite for need id references attached during the build TEST_NEED_ID_REFS_1

local-url: ../tests/test_need_id_refs#L1 remote-url: packages/sphinx-codelinks/tests/test_need_id_refs.py#L1 links outgoing: IMPL_LNK_1

Test: Test suite for attaching need id references TEST_NEED_ID_REFS_ATTACH_1

local-url: ../tests/test_need_id_refs_attach#L1 remote-url: packages/sphinx-codelinks/tests/test_need_id_refs_attach.py#L1 links outgoing: IMPL_LNK_1

Test: Test suite for the ref_url_field configuration TEST_NEED_ID_REFS_CONFIG_1

local-url: ../tests/test_need_id_refs_config#L1 remote-url: packages/sphinx-codelinks/tests/test_need_id_refs_config.py#L1 links outgoing: IMPL_LNK_1

Test: Test suite for needextend RST generation from extracted markers TEST_WRITE_1

local-url: ../tests/test_needextend_write#L1 remote-url: packages/sphinx-codelinks/tests/test_needextend_write.py#L1 links outgoing: IMPL_CLI_WRITE

Test: Test suite for one one-line need per id when src-trace scopes overlap TEST_ONE_NEED_PER_ID_1

local-url: ../tests/test_one_need_per_id#L1 remote-url: packages/sphinx-codelinks/tests/test_one_need_per_id.py#L1 links outgoing: IMPL_LNK_1

Test: Test suite for one-line comment parser functionality TEST_OLP_1

local-url: ../tests/test_oneline_parser#L1 remote-url: packages/sphinx-codelinks/tests/test_oneline_parser.py#L1 links outgoing: IMPL_OLP_1

Test: Test suite for the one-line parser's warnings in a build TEST_ONELINE_WARNINGS_1

local-url: ../tests/test_oneline_warnings#L1 remote-url: packages/sphinx-codelinks/tests/test_oneline_warnings.py#L1 links outgoing: IMPL_OLP_1

Test: Test suite for sources outside the roots their records are relative to TEST_OUTSIDE_ROOTS_1

local-url: ../tests/test_outside_roots#L1 remote-url: packages/sphinx-codelinks/tests/test_outside_roots.py#L1 links outgoing: IMPL_DISC_1

Test: Test suite for incremental builds that see new source files TEST_REDISCOVERY_1

local-url: ../tests/test_rediscovery#L1 remote-url: packages/sphinx-codelinks/tests/test_rediscovery.py#L1 links outgoing: IMPL_LNK_1

Test: Test suite for source file discovery with gitignore support TEST_DISC_1

local-url: ../tests/test_source_discover#L1 remote-url: packages/sphinx-codelinks/tests/test_source_discover.py#L1 links outgoing: IMPL_DISC_1

Test: Test suite for the source copies and pages as build state TEST_SOURCE_PAGES_1

local-url: ../tests/test_source_pages#L1 remote-url: packages/sphinx-codelinks/tests/test_source_pages.py#L1 links outgoing: IMPL_LNK_1

Test: Test suite for Sphinx extension source tracing functionality TEST_EXT_1

local-url: ../tests/test_src_trace#L1 remote-url: packages/sphinx-codelinks/tests/test_src_trace.py#L1 links outgoing: IMPL_LNK_1, IMPL_ONE_1

Test: Test suite for the URL fields' string links TEST_URL_LINKS_1

local-url: ../tests/test_url_links#L1 remote-url: packages/sphinx-codelinks/tests/test_url_links.py#L1 links outgoing: IMPL_URL_LINKS_1