Metadata-Version: 2.4
Name: sphinx-codelinks
Version: 1.0.0
Summary: Fast Source Code Traceability for Sphinx-Needs
Author-email: team useblocks <info@useblocks.com>
Maintainer-email: Marco Heinemann <marco.heinemann@useblocks.com>, Jui-Wen Chen <jui-wen.chen@useblocks.com>
Requires-Python: >= 3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: comment-parser>=1.2.4
Requires-Dist: gitignore-parser>=0.1.11
Requires-Dist: typer>=0.16.0
Requires-Dist: click < 8.2
Requires-Dist: jsonschema
Requires-Dist: sphinx>=7.4,<9
Requires-Dist: sphinx-needs>=4.2.0
Requires-Dist: jinja2
Requires-Dist: pygments
Requires-Dist: docutils
Requires-Dist: tree-sitter-cpp>=0.23.4
Requires-Dist: giturlparse>=0.12.0
Requires-Dist: tree-sitter-python>=0.23.6
Requires-Dist: tree-sitter~=0.25.1

# 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

```bash
pip install sphinx-codelinks
```

Add to your `conf.py`:

```python
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`](src/sphinx_codelinks/source_discover)): Code analysis and discovery
- **Analyse** ([`src/sphinx_codelinks/analyse`](src/sphinx_codelinks/analyse)): Documentation generation
- **Sphinx Extension** ([`src/sphinx_codelinks/sphinx_extension`](src/sphinx_codelinks/sphinx_extension)): Sphinx integration
- **Command Line** ([`src/sphinx_codelinks/cmd.py`](src/sphinx_codelinks/cmd.py)): CLI interface

## Development

See [Development Guide](docs/source/development/) for contributing guidelines.

