Skip to main content

Plugin for proper resolve intersphinx references for Qt elements

Project description

Sphinx Qt documentation 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, 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

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_qt_documentation-0.4.1.tar.gz (6.9 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page