Registry / sphinxcontrib-doxylink

sphinxcontrib-doxylink

library1.13.0pypypiunverified

Sphinx extension for linking to Doxygen documentation. Version 1.13.0 supports Python >=3.7,<4.0. Release cadence is irregular, with fixes and maintenance updates. It parses Doxygen tag files to enable cross-references to Doxygen documentation elements (classes, functions, files, etc.) from Sphinx RST or MyST content.

pip install sphinxcontrib-doxylink

github ↗package ↗docs ↗

INSTALL

IMPORT

SIG · SPHINXCONTRIB-DOXY

sphinxcontrib-doxylink

pythonv1.13.0

Install

5.5s avg

Import

—

Disk

96MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v1.13.0 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.000s · 93.7MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 5.5s · import 0.000s · 94MB

96MB installed

● package 96MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

doxylink

✓ extensions = ['sphinxcontrib.doxylink']

✗ extensions = ['doxylink']

The correct dotted module path is 'sphinxcontrib.doxylink'. Using just 'doxylink' will fail to load.

doxylink_...

✓ doxylink = {...} in conf.py

✗ doxylink_config = ...

The configuration key is 'doxylink' (a dict), not 'doxylink_config'. Users often misname it.

Minimal configuration: define the doxylink dict with a project name, base URL for the generated Doxygen HTML, and the path to the Doxygen tag file. Then add the extension to Sphinx's extensions list.

# conf.py import os doxylink = { 'project': 'MyProject', 'url': 'https://example.com/doxygen/html', 'tag': 'path/to/tagfile.xml', 'enabled': True, } extensions = ['sphinxcontrib.doxylink']

Debug

Known issues

gotchaThe 'tag' file path must be absolute or relative to the Sphinx source directory. Relative paths are resolved from the directory containing conf.py.

fix

Use an absolute path or ensure the relative path is correct relative to conf.py.

affects: all

gotchaThe Doxygen tag file must be generated with 'GENERATE_TAGFILE = YES' in the Doxyfile. If the tag file is missing or malformed, no links will be created.

fix

Set GENERATE_TAGFILE = YES in Doxyfile and regenerate.

affects: all

deprecatedIn version 1.12.0, the packaging was switched to Poetry. Users installing from source via pip should use 'pip install -e .' instead of 'python setup.py install'.

fix

Use 'pip install -e .' for editable installs.

affects: >=1.12.0

breakingCache version was introduced in 1.12.3. Old cached files may cause issues when upgrading; the extension will now re-parse the Doxygen tag file if the extension version changes.

fix

Clear the Sphinx cache (remove _build/.doctrees or build directory) after upgrading.

affects: >=1.12.3

Upgrade

Version history

1.13.0latest on PyPI · released Feb 28, 2025

Audit

Dependencies

SphinxrequiredCore dependency; the extension is a Sphinx plugin.

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/sphinx-contrib/doxylink ↗

packagehttps://pypi.org/project/sphinxcontrib-doxylink/ ↗

docshttps://sphinxcontrib-doxylink.readthedocs.io ↗