Skip to main content

Plugin for proper resolve intersphinx references for Qt elements

Project description

Sphinx Qt documentation

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

Currently it support qtpy, Qt.py wrappers and PyQt5 and PySide2.

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),
                       ...}

Project details


Download files

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

Files for sphinx-qt-documentation, version 0.2
Filename, size File type Python version Upload date Hashes
Filename, size sphinx_qt_documentation-0.2-py3-none-any.whl (4.6 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size sphinx_qt_documentation-0.2.tar.gz (4.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page