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.
Release files for sphinx-codelinks 1.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_codelinks-1.4.0.tar.gz | 47.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_codelinks-1.4.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 102.2 kB
Release files / sphinx_codelinks-1.4.0.tar.gz
| Download URL | sphinx_codelinks-1.4.0.tar.gz |
|---|---|
| Size | 47.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bf8a5f88ad4747f4964d4e4da23999a4608db6a86e4935151c17b56338d6f50d
|
|
BLAKE2b-256 checksum How to use checksums |
30aebf4b642c72b7d383723ea9ef1830d5fef5d5505165fa83e3ee1c547aea5e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 30, 2026.
Transparency logRelease files / sphinx_codelinks-1.4.0-py3-none-any.whl
| Download URL | sphinx_codelinks-1.4.0-py3-none-any.whl |
|---|---|
| Size | 54.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5cdc712a327b6ba09ea56836392cc750beaf157a342f0853ee0a773b887a7534
|
|
BLAKE2b-256 checksum How to use checksums |
285295e8e7020619e8750fbb6ebfa4470d6c5ff2d0adebd37fcbc777065f510b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 30, 2026.
Transparency log
