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
Metadata
Release files for sphinx-qt-documentation 0.4.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sphinx_qt_documentation-0.4.1.tar.gz | 6.9 kB | Without provenance | Details for sphinx_qt_documentation-0.4.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sphinx_qt_documentation-0.4.1-py3-none-any.whl | Python 3 | none | any | Details for sphinx_qt_documentation-0.4.1-py3-none-any.whl |
Total release size: 14.2 kB
Release files / sphinx_qt_documentation-0.4.1.tar.gz
| Download URL | sphinx_qt_documentation-0.4.1.tar.gz |
|---|---|
| Size | 6.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2ff1f2dcdead60b186d900220aa3ea1439827cc6319dd119ac2fff9f5eeff4b6
|
|
BLAKE2b-256 checksum How to use checksums |
056788898f06d82fdb0553382566011fc2efac4f44c78f69e8388e70475d3ab7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
Release files / sphinx_qt_documentation-0.4.1-py3-none-any.whl
| Download URL | sphinx_qt_documentation-0.4.1-py3-none-any.whl |
|---|---|
| Size | 7.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5f756640507ba3ed00020ad23b39ee0e74f10d4518366d727995ef2f59b88894
|
|
BLAKE2b-256 checksum How to use checksums |
1a759f020e662bfe50213dfb81f42afc0a02be3dcb566e6212288ba3da3d031a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
Security for sphinx-qt-documentation 0.4.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.