Sphinx CodeLinks

Important

This repository has moved. Sphinx CodeLinks is now developed in useblocks/sphinx-needs, under packages/sphinx-codelinks, with its full history. Please open issues and pull requests there. The package keeps its name on PyPI, the documentation stays at https://codelinks.useblocks.com, and this repository is archived (read-only).

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.