Traceability

Implementation

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

local-url: ../src/sphinx_codelinks/analyse/preproc/loader.py#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.py#L23 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/config.py#L23 links outgoing: FE_C_SUPPORT, FE_CPP

Implementation: One-line comment parser for traceability markers IMPL_OLP_1

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

Implementation: Support Python style comments IMPL_PY_1

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

Implementation: Python Scope Node Types IMPL_PY_2

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

Implementation: C and C++ Scope Node Types IMPL_C_2

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

Implementation: Support Go style comments IMPL_GO_2

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

Implementation: Source code file discovery with gitignore support IMPL_DISC_1

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

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

local-url: ../src/sphinx_codelinks/analyse/preproc/compile_db.py#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.py#L40 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/analyse/utils.py#L40 links outgoing: FE_GO

Implementation: Bash Scope Node Types IMPL_BASH_2

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

Implementation: Drop comments inside inactive preprocessor branches IMPL_PREPROC_2

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

Implementation: Go comment query for tree-sitter IMPL_GO_3

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

Implementation: Bash comment query for tree-sitter IMPL_BASH_3

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

Implementation: JSONC .json files require a leading comment IMPL_JSONC_3

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

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

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

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

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

Implementation: Tree-sitter parser initialization for multiple languages IMPL_LANG_1

local-url: ../src/sphinx_codelinks/analyse/utils.py#L110 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/analyse/utils.py#L110 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.py#L128 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/analyse/preproc/compile_db.py#L128 links outgoing: FE_PREPROC

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

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

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

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

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

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

Implementation: Extract need ID references from code comments IMPL_LNK_1

local-url: ../src/sphinx_codelinks/analyse/analyse.py#L256 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/analyse/analyse.py#L256 links outgoing: FE_LNK links incoming: TEST_ANA_1, TEST_ANA_2, TEST_EXT_1

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

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

Implementation: JSONC comment-to-structure association IMPL_JSONC_2

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

Implementation: Extract one-line traceability needs from comments IMPL_ONE_1

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

Implementation: Extract marked reStructuredText blocks from comments IMPL_MRST_1

local-url: ../src/sphinx_codelinks/analyse/analyse.py#L393 remote-url: packages/sphinx-codelinks/src/sphinx_codelinks/analyse/analyse.py#L393 links outgoing: FE_RST_EXTRACTION links incoming: TEST_ANA_1, TEST_ANA_2, TEST_EXT_1

Implementation: Extract reStructuredText blocks embedded in comments IMPL_RST_1

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

Testing

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

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

Test: Test suite for source analysis configuration validation TEST_CONF_1

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

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

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

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

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

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

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

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

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

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

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

Test: Test suite for Sphinx extension source tracing functionality TEST_EXT_1

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