sphinx-qt-documentation 0.4.1


pip install sphinx-qt-documentation

  Latest version

Released: Nov 12, 2022

Project Links

Meta
Author: Grzegorz Bokota
Requires Python: >=3.6

Classifiers

Development Status
  • 3 - Alpha

License
  • OSI Approved :: BSD License

Operating System
  • OS Independent

Programming Language
  • Python :: 3
  • Python :: 3 :: Only
  • Python :: 3.6
  • Python :: 3.7
  • Python :: 3.8
  • Python :: 3.9
  • Python :: 3.10
  • Python :: Implementation :: CPython

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

Extras:
Dependencies:
docutils
sphinx