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']
Sphinx-CodeLinks reads its configuration from an ubproject.toml file next to
conf.py by default (configurable via src_trace_config_from_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 2.0.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-2.0.0.tar.gz | 96.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_codelinks-2.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 207.4 kB
Release files / sphinx_codelinks-2.0.0.tar.gz
| Download URL | sphinx_codelinks-2.0.0.tar.gz |
|---|---|
| Size | 96.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9d14d266c74fcba3b953656481cdcaaabdb6ceb56a64fa240114d2212de6a72c
|
|
BLAKE2b-256 checksum How to use checksums |
a23c5f02722fec8707505442d0e85c7efada5df5dac0708795368a65c7602730
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.1 {"installer":{"name":"uv","version":"0.13.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / sphinx_codelinks-2.0.0-py3-none-any.whl
| Download URL | sphinx_codelinks-2.0.0-py3-none-any.whl |
|---|---|
| Size | 110.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ce599b3d192e7406033a798ff1cb30fd375c72f29d7ddb71a2852846ce329bae
|
|
BLAKE2b-256 checksum How to use checksums |
6da9b90eba957942d2b28d18d54d8f654f0c259f56840427967da6d6ae041d66
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.1 {"installer":{"name":"uv","version":"0.13.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
