Uploaded image for project: 'Qt for Python'
  1. Qt for Python
  2. PYSIDE-2215

Intersphinx does not work with Qt For Python documentation

    XMLWordPrintable

Details

    • Bug
    • Resolution: Out of scope
    • Not Evaluated
    • None
    • 5.15.10, 6.4.0.1
    • Documentation
    • None
    • c0329cff9 (dev), e1b95af21 (6.6), 81ae1853d (dev), 81cd88dbb (dev), 3a28afe32 (dev), 8fb28adcd (dev), 116a0bec7 (dev), b0c417c86 (dev)

    Description

      TL;DR: Sphinx capability to interlink classes from external documents does not work when pointing to PySide2/6 docs
       
      When writing sphinx documentation, the intersphinx capability lets you link to classes, modules and such from another projects by using configuration like the one below:

      example conf.py from a sphinx document.

      intersphinx_mapping = {"python": ('https://docs.python.org/3', None),
                             "click" : ("https://click.palletsprojects.com/en/latest/", None),
                             "taurus": ("https://taurus-scada.org/", None),
                             "PySide2": ("https://doc.qt.io/qtforpython-5/", None),
                             }
      

      Example rst that references two external projects:

      :py:class:`taurus.qt.qtgui.application.TaurusApplication` inherits  :py:class:`PySide2.QtWidgets.QApplication`
      

      When using intersphinx on PySide2, no links are built. Even though the example above uses PySide2, the same happens with PySide6 docs.

      NOTE: there is a sphinx extention https://github.com/Czaki/sphinx-qt-documentation that allows to achieve this. My concern is why this is needed. PySide6 docs indicates it was generated using Sphinx, so intersphinx could in principle be working without extensions.

      Attachments

        Issue Links

          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

              kleint Friedemann Kleint
              arturo_hoffstadt Arturo Hoffstadt
              Votes:
              0 Vote for this issue
              Watchers:
              6 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: