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

Improve PySide and Shiboken documentation

    XMLWordPrintable

    Details

    • Type: Epic
    • Status: Open
    • Priority: P2: Important
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: 6.1
    • Component/s: Documentation
    • Labels:
      None
    • Epic Name:
      Improve documentation

      Description

      • Improving Tutorials/Snippets/Getting started
        • e.g Snippets could be presented in C++/Python side by side
        • getting started should be fun
        • tutorials for different use cases
      • Improve documentation layout (bring in line with Qt)
      • Improve Shiboken documentation (tutorials & examples)
      • Move content from the wiki to the official docs
      • Scriptable application documentation (howto)

        Attachments

          Issue Links

          relates to

          Task - A task that needs to be done. PYSIDE-1206 Investigate how to document the global functions available with a module

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          User Story - Created by Jira Software - do not edit or delete. Issue type for a user story. PYSIDE-1106 Improve the documentation toolchain

          • P1: Critical - Urgent and Important, will STOP the release if matched with set FixVersion field. This includes regressions from the last version that are not edge cases; Data loss; Build issues; All but the most unlikely crashes/lockups/hanging; Serious usability issues and embarrassing bugs & Bugs critical to a deliverable. This is the highest possible priority for requirements.
          • Open
          For Gerrit Dashboard: PYSIDE-1112
          # Subject Branch Project Status CR V
          285574,10 Add a widget gallery example 5.15 qt/qtbase Status: MERGED +2 0
          286554,2 Add documentation for the widget gallery 5.15 qt/qtbase Status: MERGED +2 0
          291411,4 Re-structure shiboken documentation 5.14 pyside/pyside-setup Status: MERGED +2 0
          298733,2 Mark widget gallery example as "gallery" dev qt/qtbase Status: MERGED +2 0
          300967,2 Mark widget gallery example as "gallery" 5.15 qt/qtbase Status: MERGED +2 0
          333540,4 example: add qtquickcontrols2 gallery dev pyside/pyside-setup Status: MERGED +2 0
          333701,2 example: add qtquickcontrols2 gallery 6.0 pyside/pyside-setup Status: MERGED +2 0
          335072,4 doc: example gallery show code in tabs dev pyside/pyside-setup Status: MERGED +2 0
          335235,2 doc: example gallery show code in tabs 6.0 pyside/pyside-setup Status: MERGED +2 0
          335255,6 doc: use 'doc' directory for examples gallery dev pyside/pyside-setup Status: MERGED +2 0
          339198,5 doc: add sphinx-panels to the documentation dev pyside/pyside-setup Status: MERGED +2 0
          339199,5 doc: migrate qdoc approach to document examples dev pyside/pyside-setup Status: MERGED +2 0
          339310,2 doc: use 'doc' directory for examples gallery 6.0 pyside/pyside-setup Status: MERGED +2 0
          339451,2 doc: add sphinx-panels to the documentation 6.0 pyside/pyside-setup Status: MERGED +2 0
          339452,2 doc: migrate qdoc approach to document examples 6.0 pyside/pyside-setup Status: MERGED +2 0
          339682,5 Improve Porting documentation dev pyside/pyside-setup Status: MERGED +2 0
          339730,2 Improve Porting documentation 6.0 pyside/pyside-setup Status: MERGED +2 0
          339836,4 Improve deployment documentation dev pyside/pyside-setup Status: MERGED +2 0
          340093,8 Replace % formatting in examples by f-strings dev pyside/pyside-setup Status: MERGED +2 0
          340129,2 Improve deployment documentation 6.0 pyside/pyside-setup Status: MERGED +2 0
          340223,3 Replace .format() in examples by f-strings dev pyside/pyside-setup Status: MERGED +2 0
          340282,2 Remove the regexp example dev pyside/pyside-setup Status: MERGED +2 0
          340283,2 Update the examples project file dev pyside/pyside-setup Status: MERGED +2 0
          340320,2 Use pathlib in examples dev pyside/pyside-setup Status: MERGED +2 0
          340526,2 Port the widget tutorials to snake case dev pyside/pyside-setup Status: MERGED +2 0
          340561,3 Brush up the hellogl2 example dev pyside/pyside-setup Status: MERGED +2 0
          340562,5 Port non-QWidget examples to snake case dev pyside/pyside-setup Status: MERGED -1 0
          340601,3 Brush up the main window examples dev pyside/pyside-setup Status: MERGED +2 0
          340704,1 WIP: Port QWidget examples to snake case dev pyside/pyside-setup Status: ABANDONED -2 0
          340802,8 Port QWidget examples to snake case dev pyside/pyside-setup Status: MERGED +2 0
          340811,2 Brush up the easing example dev pyside/pyside-setup Status: MERGED +2 0
          341140,6 Brush up the standarddialogs example dev pyside/pyside-setup Status: MERGED +2 0
          341218,2 Brush up the collidingmice example dev pyside/pyside-setup Status: MERGED +2 0
          341766,4 Brush up the syntax highlighter example dev pyside/pyside-setup Status: MERGED +2 0
          342030,21 Rewrite the classwizard example dev pyside/pyside-setup Status: MERGED +2 0
          342178,10 WIP: classwizard example: Add a qobject parameter page dev pyside/pyside-setup Status: ABANDONED -2 0
          342529,2 classwizard example: Update icons dev pyside/pyside-setup Status: MERGED +2 0
          343166,5 Brush up the mandelbrot example dev pyside/pyside-setup Status: MERGED +2 0
          343725,2 doc: use sphinx panels in shiboken docs dev pyside/pyside-setup Status: MERGED +2 0
          343789,2 doc: use sphinx panels in shiboken docs 6.0 pyside/pyside-setup Status: MERGED +2 0
          344649,8 Cannon tutorial: Brush up code dev pyside/pyside-setup Status: MERGED +2 0
          344690,2 Tetrix example: Use per class imports dev pyside/pyside-setup Status: MERGED +2 0
          344692,2 Brush up the dragdroprobot example dev pyside/pyside-setup Status: MERGED +2 0
          344841,5 Rewrite the fetchmore example dev pyside/pyside-setup Status: MERGED +2 0
          344911,2 classwizard example: Update documentation and screenshot dev pyside/pyside-setup Status: MERGED +2 0
          344934,2 classwizard example: Use and generate super() without parameters dev pyside/pyside-setup Status: MERGED +2 0
          345068,6 Remaining QGraphicsView examples: Use per-class imports dev pyside/pyside-setup Status: MERGED +2 0
          345098,6 Remaining examples: Use per-class imports dev pyside/pyside-setup Status: MERGED +2 0
          345108,4 Fix the text object example dev pyside/pyside-setup Status: MERGED +2 0
          345127,2 Fix the text object example tqtc/lts-5.15 pyside/tqtc-pyside-setup Status: MERGED +2 0
          346172,3 Examples: Use new form of super() dev pyside/pyside-setup Status: MERGED +2 0
          346429,4 Examples: Fix some space-related flake warnings dev pyside/pyside-setup Status: MERGED +2 0
          348019,2 sample binding: Document how to force MSVC in case CMake detects clang dev pyside/pyside-setup Status: MERGED +2 0
          348340,2 sample binding: Document how to force MSVC in case CMake detects clang 6.1 pyside/pyside-setup Status: MERGED +2 0
          348341,2 sample binding: Document how to force MSVC in case CMake detects clang 6.1.0 pyside/pyside-setup Status: MERGED +2 0
          349319,2 Fix the widget gallery example dev pyside/pyside-setup Status: MERGED +2 0
          349381,2 Fix the widget gallery example 6.1 pyside/pyside-setup Status: MERGED +2 0
          349426,8 Fix the multimedia examples to work dev pyside/pyside-setup Status: MERGED +2 0
          349571,2 Fix the multimedia examples to work 6.1 pyside/pyside-setup Status: MERGED +2 0
          349643,12 Port the richtext/textedit example dev pyside/pyside-setup Status: MERGED +2 0
          349992,3 Polish the QtWebChannel example dev pyside/pyside-setup Status: MERGED +2 0
          350084,2 Port the richtext/textedit example 6.1 pyside/pyside-setup Status: MERGED +2 0
          356418,6 shiboken6/doc generator: Fix tables nested in paragraphs dev pyside/pyside-setup Status: MERGED +2 0
          356598,4 shiboken6/doc generator: Extract method to resolve links to QtXmlToSphinxDocGeneratorInterface dev pyside/pyside-setup Status: MERGED +2 0
          356599,4 shiboken6/doc generator: Resolve relative, local .html documents to doc.qt.io dev pyside/pyside-setup Status: MERGED +2 0
          356676,2 shiboken6/doc generator: Fix tables nested in paragraphs 6.1 pyside/pyside-setup Status: MERGED +2 0
          356677,2 shiboken6/doc generator: Extract method to resolve links to QtXmlToSphinxDocGeneratorInterface 6.1 pyside/pyside-setup Status: MERGED +2 0
          356678,3 shiboken6/doc generator: Resolve relative, local .html documents to doc.qt.io 6.1 pyside/pyside-setup Status: MERGED +2 0
          356748,3 PySide6: Update documentation on Qt Designer and resource files dev pyside/pyside-setup Status: MERGED +2 0
          357130,2 PySide6: Update documentation on Qt Designer and resource files 6.1 pyside/pyside-setup Status: MERGED +2 0
          357387,3 shiboken6/Documentation: Add a link from code injection to type system variables dev pyside/pyside-setup Status: MERGED +2 0
          357420,2 shiboken6/Documentation: Add a link from code injection to type system variables 6.1 pyside/pyside-setup Status: MERGED +2 0
          382241,7 Documentation: Fix most sphinx errors "Inline strong start-string without end-string." dev pyside/pyside-setup Status: MERGED +2 0
          382621,3 Doumentation: Suppress nested formatting dev pyside/pyside-setup Status: MERGED +2 0
          382675,2 Documentation: Fix most sphinx errors "Inline strong start-string without end-string." 6.2 pyside/pyside-setup Status: MERGED +2 0
          382676,2 Doumentation: Suppress nested formatting 6.2 pyside/pyside-setup Status: MERGED +2 0
          412750,5 doc: add package detail page dev pyside/pyside-setup Status: MERGED +2 0
          421043,2 doc: add package detail page 6.3 pyside/pyside-setup Status: MERGED +2 0

            Activity

              People

              Assignee:
              kleint Friedemann Kleint
              Reporter:
              ablasche Alex Blasche
              PM Owner:
              Maurice Kalinowski Maurice Kalinowski
              RnD Owner:
              Alex Blasche Alex Blasche
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:

                  Gerrit Reviews

                  There are no open Gerrit changes