Skip to content
  • Categories
  • Recent
  • Tags
  • Popular
  • Users
  • Groups
  • Search
  • Get Qt Extensions
  • Unsolved
Collapse
Brand Logo
  1. Home
  2. Qt Development
  3. General and Desktop
  4. [Community Contribution] Offline PySide6 v6.11.1 Documentation (HTML Archive & Standalone .qch)
Qt 6.11 is out! See what's new in the release blog

[Community Contribution] Offline PySide6 v6.11.1 Documentation (HTML Archive & Standalone .qch)

Scheduled Pinned Locked Moved Solved General and Desktop
2 Posts 2 Posters 143 Views
  • Oldest to Newest
  • Newest to Oldest
  • Most Votes
Reply
  • Reply as topic
Log in to reply
This topic has been deleted. Only users with topic management privileges can see it.
  • M Offline
    M Offline
    mandman
    wrote last edited by mandman
    #1

    Hi everyone,

    As many of you know, official PySide6 wheels exclude local documentation datasets to keep the binary download sizes small. Building the PySide6 documentation from source can be notoriously difficult due to strict compiler, Sphinx, and Shiboken dependency requirements.

    To save other developers the setup and compilation headaches, I have successfully built the complete offline documentation for PySide6 v6.11.1 and made it publicly available.

    📦 Where to Get It
    You can find the project repository and download the files here:[https://github.com/yhtwyl/Pyside6-html-documentation.git]. Because the compiled documentation contains thousands of files and large binaries, everything has been packaged into single-file downloads available on the Releases page of the repository.

    🛠️ Formats Available
    pyside6-docs.tar.xz: Contains the complete, web-viewable HTML documentation tree. Perfect for local browsing in any web browser without an active internet connection.
    pyside6.qch (Qt Compressed Help): A single, unified binary file that integrates directly into your IDE. It contains all core modules (QtWidgets, QtCore, QtGui, etc.). I have not separated it from the parent folder so you will have to extract the pyside6-docs.tar.xz and inside html folder you will find the pyside6.qch file.

    🚀 How to Integrate the .qch File into Qt Creator
    To get native, instant F1 help text lookups inside your IDE:

    • Open Qt Creator and go to Edit > Preferences > Help > Documentation.
    • Click the Add... button.
    • Select your downloaded pyside6.qch file and click Apply.

    Hopefully, this saves you some development and compilation time, especially if you regularly work in secure offline environments, air-gapped networks, or on the go!Feel free to check out the repository's main page if you are interested in the pinned dependency versions ("the recipe") used to build this environment. Feedback and comments are welcome!Happy coding,

    1 Reply Last reply
    2
    • M mandman has marked this topic as solved
    • ansifpiA Offline
      ansifpiA Offline
      ansifpi
      wrote last edited by
      #2

      Nice work

      Full Stack Developer

      Ansif P I

      1 Reply Last reply
      0

      • Login

      • Login or register to search.
      • First post
        Last post
      0
      • Categories
      • Recent
      • Tags
      • Popular
      • Users
      • Groups
      • Search
      • Get Qt Extensions
      • Unsolved