https://github.com/czaki/sphinx-qt-documentation

sphinx plugin for generate remote links using intersphinx
https://github.com/czaki/sphinx-qt-documentation

Last synced: 2 months ago
JSON representation

sphinx plugin for generate remote links using intersphinx

• Host: GitHub
• URL: https://github.com/czaki/sphinx-qt-documentation
• Owner: Czaki
• License: bsd-3-clause
• Created: 2020-02-05T15:23:39.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-28T23:18:35.000Z (2 months ago)
• Last Synced: 2024-10-29T00:20:18.088Z (2 months ago)
• Language: Python
• Homepage:
• Size: 40 KB
• Stars: 14
• Watchers: 3
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Sphinx Qt documentation

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Czaki/sphinx-qt-documentation/master.svg)](https://results.pre-commit.ci/latest/github/Czaki/sphinx-qt-documentation/master)

[![Tests](https://github.com/Czaki/sphinx-qt-documentation/actions/workflows/test.yaml/badge.svg)](https://github.com/Czaki/sphinx-qt-documentation/actions/workflows/test.yaml)

[![PyPI version](https://badge.fury.io/py/sphinx-qt-documentation.svg)](https://badge.fury.io/py/sphinx-qt-documentation)

[![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

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` and`PySide6`.

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.:

```python

intersphinx_mapping = {...

                       "PyQt5": (custom_url, None),

                       ...}

```

This package currently does not support linking PyQt5 documentation using PySide2 `.inv` file