{"id":24631,"library":"sphinxcontrib-doxylink","title":"sphinxcontrib-doxylink","description":"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.","status":"active","version":"1.13.0","language":"python","source_language":"en","source_url":"https://github.com/sphinx-contrib/doxylink","tags":["sphinx","doxygen","documentation","cross-reference"],"install":[{"cmd":"pip install sphinxcontrib-doxylink","lang":"bash","label":"Install from PyPI"}],"dependencies":[{"reason":"Core dependency; the extension is a Sphinx plugin.","package":"Sphinx","optional":false}],"imports":[{"note":"The correct dotted module path is 'sphinxcontrib.doxylink'. Using just 'doxylink' will fail to load.","wrong":"extensions = ['doxylink']","symbol":"doxylink","correct":"extensions = ['sphinxcontrib.doxylink']"},{"note":"The configuration key is 'doxylink' (a dict), not 'doxylink_config'. Users often misname it.","wrong":"doxylink_config = ...","symbol":"doxylink_...","correct":"doxylink = {...} in conf.py"}],"quickstart":{"code":"# conf.py\nimport os\n\ndoxylink = {\n    'project': 'MyProject',\n    'url': 'https://example.com/doxygen/html',\n    'tag': 'path/to/tagfile.xml',\n    'enabled': True,\n}\n\nextensions = ['sphinxcontrib.doxylink']","lang":"python","description":"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."},"warnings":[{"fix":"Use an absolute path or ensure the relative path is correct relative to conf.py.","message":"The 'tag' file path must be absolute or relative to the Sphinx source directory. Relative paths are resolved from the directory containing conf.py.","severity":"gotcha","affected_versions":"all"},{"fix":"Set GENERATE_TAGFILE = YES in Doxyfile and regenerate.","message":"The 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.","severity":"gotcha","affected_versions":"all"},{"fix":"Use 'pip install -e .' for editable installs.","message":"In 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'.","severity":"deprecated","affected_versions":">=1.12.0"},{"fix":"Clear the Sphinx cache (remove _build/.doctrees or build directory) after upgrading.","message":"Cache 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.","severity":"breaking","affected_versions":">=1.12.3"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Use 'doxylink' (a dict) instead of 'doxylink_config'.","cause":"Using the wrong configuration variable name in conf.py.","error":"Extension 'doxylink' has no configuration key 'doxylink_config'"},{"fix":"Run 'pip install sphinxcontrib-doxylink' and ensure the Python environment is correct.","cause":"The extension is not installed or is installed but not importable.","error":"No module named 'sphinxcontrib.doxylink'"},{"fix":"Verify the tag file exists. Use an absolute path or correct relative path from conf.py.","cause":"The 'tag' path in the doxylink config points to a non-existent file.","error":"Error reading tag file: FileNotFoundError"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}