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

Improve PySide and Shiboken documentation

    XMLWordPrintable

Details

    • Epic
    • Resolution: Unresolved
    • P2: Important
    • 6.1
    • None
    • Documentation
    • None
    • 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

          Activity

            People

              kleint Friedemann Kleint
              ablasche Alex Blasche
              Maurice Kalinowski Maurice Kalinowski
              Alex Blasche Alex Blasche
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated: