sphinx-qt-documentation

Name	sphinx-qt-documentation JSON
Version	0.4.1 JSON
	download
home_page	https://github.com/Czaki/sphinx-qt-documentation
Summary	Plugin for proper resolve intersphinx references for Qt elements
upload_time	2022-11-12 15:36:58
maintainer
docs_url	None
author	Grzegorz Bokota
requires_python	>=3.6
license	BSD-3-Clause
keywords	sphinx qt pyqt5 pyside2 pyqt6 pyside6
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Czaki/sphinx-qt-documentation",
    "name": "sphinx-qt-documentation",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "Sphinx,Qt,PyQt5,PySide2,PyQt6,PySide6",
    "author": "Grzegorz Bokota",
    "author_email": "bokota@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/05/67/88898f06d82fdb0553382566011fc2efac4f44c78f69e8388e70475d3ab7/sphinx_qt_documentation-0.4.1.tar.gz",
    "platform": "Linux",
    "description": "# Sphinx Qt documentation\n\n[![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)\n[![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)\n[![PyPI version](https://badge.fury.io/py/sphinx-qt-documentation.svg)](https://badge.fury.io/py/sphinx-qt-documentation)\n[![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n\n\nThis is plugin to add cross-link to qt documentation for python code created with PyQt5 or PySide2.\n\nCurrently, it supports `qtpy`, `Qt.py` wrappers and `PyQt5`, `PySide2`, `PyQt6` and`PySide6`.\n\nThis extension provides one configuration option:\n\n`qt_documentation` with possible values:\n\n* PyQt5 - linking to PyQt documentation on https://www.riverbankcomputing.com/static/Docs/PyQt5/api/ (incomplete)\n* Qt5 - linking to Qt5 documentation on \"https://doc.qt.io/qt-5/\" (default)\n* PySide2 - linking to PySide6 documentation on  \"https://doc.qt.io/qtforpython-5/\"\n* PyQt6 - linking to PyQt documentation on https://www.riverbankcomputing.com/static/Docs/PyQt6/api/ (incomplete)\n* Qt6 - linking to Qt5 documentation on \"https://doc.qt.io/qt-6/\"\n* PySide6 - linking to PySide6 documentation on  \"https://doc.qt.io/qtforpython/PySide6/\"\n\nFor default this extension use `inv` file from PyQt5 to resolve objects.\nto overwrite this behaviour set another url for `intersphinx_mapping[PyQt5]` ex.:\n\n```python\nintersphinx_mapping = {...\n                       \"PyQt5\": (custom_url, None),\n                       ...}\n```\n\nThis package currently does not support linking PyQt5 documentation using PySide2 `.inv` file\n",
    "bugtrack_url": null,
    "license": "BSD-3-Clause",
    "summary": "Plugin for proper resolve intersphinx references for Qt elements",
    "version": "0.4.1",
    "project_urls": {
        "Homepage": "https://github.com/Czaki/sphinx-qt-documentation"
    },
    "split_keywords": [
        "sphinx",
        "qt",
        "pyqt5",
        "pyside2",
        "pyqt6",
        "pyside6"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1a759f020e662bfe50213dfb81f42afc0a02be3dcb566e6212288ba3da3d031a",
                "md5": "193c0a71fcb4bd2eb04a77c23300cffc",
                "sha256": "5f756640507ba3ed00020ad23b39ee0e74f10d4518366d727995ef2f59b88894"
            },
            "downloads": -1,
            "filename": "sphinx_qt_documentation-0.4.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "193c0a71fcb4bd2eb04a77c23300cffc",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 7304,
            "upload_time": "2022-11-12T15:36:55",
            "upload_time_iso_8601": "2022-11-12T15:36:55.885685Z",
            "url": "https://files.pythonhosted.org/packages/1a/75/9f020e662bfe50213dfb81f42afc0a02be3dcb566e6212288ba3da3d031a/sphinx_qt_documentation-0.4.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "056788898f06d82fdb0553382566011fc2efac4f44c78f69e8388e70475d3ab7",
                "md5": "c64d29e327058431452b134f45e1d1b4",
                "sha256": "2ff1f2dcdead60b186d900220aa3ea1439827cc6319dd119ac2fff9f5eeff4b6"
            },
            "downloads": -1,
            "filename": "sphinx_qt_documentation-0.4.1.tar.gz",
            "has_sig": false,
            "md5_digest": "c64d29e327058431452b134f45e1d1b4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 6923,
            "upload_time": "2022-11-12T15:36:58",
            "upload_time_iso_8601": "2022-11-12T15:36:58.025096Z",
            "url": "https://files.pythonhosted.org/packages/05/67/88898f06d82fdb0553382566011fc2efac4f44c78f69e8388e70475d3ab7/sphinx_qt_documentation-0.4.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-11-12 15:36:58",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Czaki",
    "github_project": "sphinx-qt-documentation",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "sphinx-qt-documentation"
}