Fast Source Code Traceability for Sphinx-Needs
Project description
Sphinx CodeLinks
A Sphinx extension for discovering, linking, and documenting source code across projects.
Features
- Source Discovery: Automatically discover source files in your project
- Analyse: Parse source codes and extract specified markers with their metadata
- Code Linking: Create intelligent links between code elements
- Sphinx Integration: Seamless integration with existing Sphinx documentation
Quick Start
pip install sphinx-codelinks
Add to your conf.py:
extensions = ['sphinx_needs', 'sphinx_codelinks']
src_trace_config_from_toml = "codelinks.toml"
Documentation
Full documentation: https://codelinks.useblocks.com
Components
- Source Discovery (
src/sphinx_codelinks/source_discover): Code analysis and discovery - Analyse (
src/sphinx_codelinks/analyse): Documentation generation - Sphinx Extension (
src/sphinx_codelinks/sphinx_extension): Sphinx integration - Command Line (
src/sphinx_codelinks/cmd.py): CLI interface
Development
See Development Guide for contributing guidelines.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sphinx_codelinks-1.2.0.tar.gz.
File metadata
- Download URL: sphinx_codelinks-1.2.0.tar.gz
- Upload date:
- Size: 33.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bf0f5ca6c7f6be139a73ce01d2cda091a318eea6824d25f154543d7334118436
|
|
| MD5 |
9444d6f03b7697460f64e4ba42a25e8d
|
|
| BLAKE2b-256 |
34bacd6a8ac1cb3bbb0ada060215e655e012c4e0058f5b1785179c2ac5487eaa
|
Provenance
The following attestation bundles were made for sphinx_codelinks-1.2.0.tar.gz:
Publisher:
release.yaml on useblocks/sphinx-codelinks
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sphinx_codelinks-1.2.0.tar.gz -
Subject digest:
bf0f5ca6c7f6be139a73ce01d2cda091a318eea6824d25f154543d7334118436 - Sigstore transparency entry: 968927170
- Sigstore integration time:
-
Permalink:
useblocks/sphinx-codelinks@d30193c63d2475eb919b36e48c8b421331c61482 -
Branch / Tag:
refs/tags/1.2.0 - Owner: https://github.com/useblocks
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@d30193c63d2475eb919b36e48c8b421331c61482 -
Trigger Event:
push
-
Statement type:
File details
Details for the file sphinx_codelinks-1.2.0-py3-none-any.whl.
File metadata
- Download URL: sphinx_codelinks-1.2.0-py3-none-any.whl
- Upload date:
- Size: 39.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
046cb12f9fa3b7f36fed97522263f6a705a22c165e135395060a08830e0d42b8
|
|
| MD5 |
9db462412a871181fe9244d8d7068458
|
|
| BLAKE2b-256 |
eb852765dcffe0db7e2de35cf29450fe69ddafc4d97053cf5a0ee6e7e4b9c4f4
|
Provenance
The following attestation bundles were made for sphinx_codelinks-1.2.0-py3-none-any.whl:
Publisher:
release.yaml on useblocks/sphinx-codelinks
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sphinx_codelinks-1.2.0-py3-none-any.whl -
Subject digest:
046cb12f9fa3b7f36fed97522263f6a705a22c165e135395060a08830e0d42b8 - Sigstore transparency entry: 968927306
- Sigstore integration time:
-
Permalink:
useblocks/sphinx-codelinks@d30193c63d2475eb919b36e48c8b421331c61482 -
Branch / Tag:
refs/tags/1.2.0 - Owner: https://github.com/useblocks
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@d30193c63d2475eb919b36e48c8b421331c61482 -
Trigger Event:
push
-
Statement type:
