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 supports qtpy
, Qt.py
wrappers and PyQt5
, PySide2
, PyQt6
andPySide6
.
This extension provides one configuration option:
qt_documentation
with possible values:
- PyQt5 - linking to PyQt documentation on https://www.riverbankcomputing.com/static/Docs/PyQt5/api/ (incomplete)
- Qt5 - linking to Qt5 documentation on "https://doc.qt.io/qt-5/" (default)
- PySide2 - linking to PySide6 documentation on "https://doc.qt.io/qtforpython-5/"
- PyQt6 - linking to PyQt documentation on https://www.riverbankcomputing.com/static/Docs/PyQt6/api/ (incomplete)
- Qt6 - linking to Qt5 documentation on "https://doc.qt.io/qt-6/"
- PySide6 - linking to PySide6 documentation on "https://doc.qt.io/qtforpython/PySide6/"
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
Built Distribution
File details
Details for the file sphinx_qt_documentation-0.4.1.tar.gz
.
File metadata
- Download URL: sphinx_qt_documentation-0.4.1.tar.gz
- Upload date:
- Size: 6.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 colorama/0.4.4 importlib-metadata/4.6.4 keyring/23.5.0 pkginfo/1.8.2 readme-renderer/34.0 requests-toolbelt/0.9.1 requests/2.25.1 rfc3986/1.5.0 tqdm/4.57.0 urllib3/1.26.5 CPython/3.10.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2ff1f2dcdead60b186d900220aa3ea1439827cc6319dd119ac2fff9f5eeff4b6 |
|
MD5 | c64d29e327058431452b134f45e1d1b4 |
|
BLAKE2b-256 | 056788898f06d82fdb0553382566011fc2efac4f44c78f69e8388e70475d3ab7 |
File details
Details for the file sphinx_qt_documentation-0.4.1-py3-none-any.whl
.
File metadata
- Download URL: sphinx_qt_documentation-0.4.1-py3-none-any.whl
- Upload date:
- Size: 7.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 colorama/0.4.4 importlib-metadata/4.6.4 keyring/23.5.0 pkginfo/1.8.2 readme-renderer/34.0 requests-toolbelt/0.9.1 requests/2.25.1 rfc3986/1.5.0 tqdm/4.57.0 urllib3/1.26.5 CPython/3.10.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5f756640507ba3ed00020ad23b39ee0e74f10d4518366d727995ef2f59b88894 |
|
MD5 | 193c0a71fcb4bd2eb04a77c23300cffc |
|
BLAKE2b-256 | 1a759f020e662bfe50213dfb81f42afc0a02be3dcb566e6212288ba3da3d031a |