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:
- PyQt5 - linking to PyQt documentation on https://www.riverbankcomputing.com/static/Docs/PyQt5/ (incomplete)
- Qt5 - linking to Qt5 documentation on "https://doc.qt.io/qt-5/" (default)
- PySide2 - linking to PySide2 documentation on "https://doc.qt.io/qtforpython/PySide2/"
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size sphinx_qt_documentation-0.3-py3-none-any.whl (5.6 kB) | File type Wheel | Python version py3 | Upload date | Hashes View |
Filename, size sphinx_qt_documentation-0.3.tar.gz (5.2 kB) | File type Source | Python version None | Upload date | Hashes View |
Close
Hashes for sphinx_qt_documentation-0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bee247cb9e4fc03fc496d07adfdb943100e1103320c3e5e820e0cfa7c790d9b6 |
|
MD5 | b1e3b4ab34348ae5e74aba1fde14687e |
|
BLAKE2-256 | 2e6d7e638cfc0861d1e7e9980e2d25fe805d2fe052a525a4b067d313d45450ff |
Close
Hashes for sphinx_qt_documentation-0.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f09a0c9d9e989172ba3e282b92bf55613bb23ad47315ec5b0d38536b343ac6c8 |
|
MD5 | ed5f1a25d6004139addc4af91c3882ab |
|
BLAKE2-256 | 023dc3aeaddb501d0f27fadef98bb698e94e505955f56b6e2e4df37aa291dd65 |