Skip to main content

Plugin for proper resolve intersphinx references for Qt elements

Project description

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

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.tar.gz (6.8 kB view details)

Uploaded Source

Built Distribution

sphinx_qt_documentation-0.4-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_qt_documentation-0.4.tar.gz.

File metadata

  • Download URL: sphinx_qt_documentation-0.4.tar.gz
  • Upload date:
  • Size: 6.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for sphinx_qt_documentation-0.4.tar.gz
Algorithm Hash digest
SHA256 f43ba17baa93e353fb94045027fb67f9d935ed158ce8662de93f08b88eec6774
MD5 9fe0c782358a8ed9ead06e42abe10c3e
BLAKE2b-256 7b9a8f5e78c0b2fbee46978f846f83c160bd921cfc983deff70bfeb180f3806b

See more details on using hashes here.

Provenance

File details

Details for the file sphinx_qt_documentation-0.4-py3-none-any.whl.

File metadata

  • Download URL: sphinx_qt_documentation-0.4-py3-none-any.whl
  • Upload date:
  • Size: 7.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for sphinx_qt_documentation-0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 fa131093f75cd1bd48699cd132e18e4d46ba9eaadc070e6026867cea75ecdb7b
MD5 9a5f70d594285947dd44dea5e455e38a
BLAKE2b-256 cf4061df2d87995e1edcc9929c7811ff099976033363c56a9ced45ebb5fa0534

See more details on using hashes here.

Provenance

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