Oven logo

Oven

Published

Plugin for proper resolve intersphinx references for Qt elements

Sphinx Qt documentation

pre-commit.ci status Tests PyPI version Code Style

This is plugin to add cross-link to qt documentation for python code created with PyQt5 or PySide2.

Currently, it supports qtpy, Qt.py wrappers and PyQt5, PySide2, PyQt6 andPySide6.

This extension provides one configuration option:

qt_documentation with possible values:

For default this extension use inv file from PyQt5 to resolve objects. to overwrite this behaviour set another url for intersphinx_mapping[PyQt5] ex.:

intersphinx_mapping = {...
                       "PyQt5": (custom_url, None),
                       ...}

This package currently does not support linking PyQt5 documentation using PySide2 .inv file