Loading...

XML

Word

Printable

Type: Epic
Resolution: Unresolved
Priority: P2: Important
Fix Version/s: 6.1
Affects Version/s: None
Component/s: Documentation
Labels:
None

Epic Name:
Improve documentation

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)

relates to

PYSIDE-1206 Investigate how to document the global functions available with a module

Closed

PYSIDE-1106 Improve the documentation toolchain

Open

- Issue Only
- Show All Reviews
- Show Open Reviews

For Gerrit Dashboard: PYSIDE-1112
#	Subject	Branch	Project	Status	CR	V
540520,23	WIP: Documentation: Write module class TOCs with brief	dev	pyside/pyside-setup	Status: NEW	-2	0

Assignee:: Friedemann Kleint

Reporter:: Alex Blasche

PM Owner:: Maurice Kalinowski

RnD Owner:: Alex Blasche

Votes:: 0 Vote for this issue

Watchers:: 3 Start watching this issue

Created:: 18 Oct '19 03:16

Updated:: 07 Jun '21 04:03

There is 1 open Gerrit change

WIP: Documentation: Write module class TOCs with brief

-2 Gerrit Review:

Show There are 99 closed Gerrit changes

Hide There are 99 closed Gerrit changes

Re-structure shiboken documentation: Gerrit Review:

Mark widget gallery example as "gallery": Gerrit Review:

Mark widget gallery example as "gallery": Gerrit Review:

example: add qtquickcontrols2 gallery: Gerrit Review:

example: add qtquickcontrols2 gallery: Gerrit Review:

doc: example gallery show code in tabs: Gerrit Review:

doc: example gallery show code in tabs: Gerrit Review:

doc: use 'doc' directory for examples gallery: Gerrit Review:

doc: add sphinx-panels to the documentation: Gerrit Review:

doc: migrate qdoc approach to document examples: Gerrit Review:

doc: use 'doc' directory for examples gallery: Gerrit Review:

doc: add sphinx-panels to the documentation: Gerrit Review:

doc: migrate qdoc approach to document examples: Gerrit Review:

Improve Porting documentation: Gerrit Review:

Improve Porting documentation: Gerrit Review:

Improve deployment documentation: Gerrit Review:

Replace % formatting in examples by f-strings: Gerrit Review:

Improve deployment documentation: Gerrit Review:

Replace .format() in examples by f-strings: Gerrit Review:

Remove the regexp example: Gerrit Review:

Update the examples project file: Gerrit Review:

Use pathlib in examples: Gerrit Review:

Port the widget tutorials to snake case: Gerrit Review:

Brush up the hellogl2 example: Gerrit Review:

Port non-QWidget examples to snake case: Gerrit Review:

Brush up the main window examples: Gerrit Review:

WIP: Port QWidget examples to snake case: Gerrit Review:

Port QWidget examples to snake case: Gerrit Review:

Brush up the easing example: Gerrit Review:

Brush up the standarddialogs example: Gerrit Review:

Brush up the collidingmice example: Gerrit Review:

Brush up the syntax highlighter example: Gerrit Review:

Rewrite the classwizard example: Gerrit Review:

WIP: classwizard example: Add a qobject parameter page: Gerrit Review:

classwizard example: Update icons: Gerrit Review:

Brush up the mandelbrot example: Gerrit Review:

doc: use sphinx panels in shiboken docs: Gerrit Review:

doc: use sphinx panels in shiboken docs: Gerrit Review:

Cannon tutorial: Brush up code: Gerrit Review:

Tetrix example: Use per class imports: Gerrit Review:

Brush up the dragdroprobot example: Gerrit Review:

Rewrite the fetchmore example: Gerrit Review:

classwizard example: Update documentation and screenshot: Gerrit Review:

classwizard example: Use and generate super() without parameters: Gerrit Review:

Remaining QGraphicsView examples: Use per-class imports: Gerrit Review:

Remaining examples: Use per-class imports: Gerrit Review:

Fix the text object example: Gerrit Review:

Fix the text object example: Gerrit Review:

Examples: Use new form of super(): Gerrit Review:

Examples: Fix some space-related flake warnings: Gerrit Review:

sample binding: Document how to force MSVC in case CMake detects clang: Gerrit Review:

sample binding: Document how to force MSVC in case CMake detects clang: Gerrit Review:

sample binding: Document how to force MSVC in case CMake detects clang: Gerrit Review:

Fix the widget gallery example: Gerrit Review:

Fix the widget gallery example: Gerrit Review:

Fix the multimedia examples to work: Gerrit Review:

Fix the multimedia examples to work: Gerrit Review:

Port the richtext/textedit example: Gerrit Review:

Polish the QtWebChannel example: Gerrit Review:

Port the richtext/textedit example: Gerrit Review:

shiboken6/doc generator: Fix tables nested in paragraphs: Gerrit Review:

shiboken6/doc generator: Extract method to resolve links to QtXmlToSphinxDocGeneratorInterface: Gerrit Review:

shiboken6/doc generator: Resolve relative, local .html documents to doc.qt.io: Gerrit Review:

shiboken6/doc generator: Fix tables nested in paragraphs: Gerrit Review:

shiboken6/doc generator: Extract method to resolve links to QtXmlToSphinxDocGeneratorInterface: Gerrit Review:

shiboken6/doc generator: Resolve relative, local .html documents to doc.qt.io: Gerrit Review:

PySide6: Update documentation on Qt Designer and resource files: Gerrit Review:

PySide6: Update documentation on Qt Designer and resource files: Gerrit Review:

shiboken6/Documentation: Add a link from code injection to type system variables: Gerrit Review:

shiboken6/Documentation: Add a link from code injection to type system variables: Gerrit Review:

Documentation: Fix most sphinx errors "Inline strong start-string without end-string.": Gerrit Review:

Doumentation: Suppress nested formatting: Gerrit Review:

Documentation: Fix most sphinx errors "Inline strong start-string without end-string.": Gerrit Review:

Doumentation: Suppress nested formatting: Gerrit Review:

doc: add package detail page: Gerrit Review:

doc: add package detail page: Gerrit Review:

Fix doc warning: Gerrit Review:

Fix doc warning: Gerrit Review:

shiboken6: Remove left-over debug statement: Gerrit Review:

shiboken6: Remove left-over debug statement: Gerrit Review:

doc: Update copyright year to 2024: Gerrit Review:

QtAsyncio: Add documentation page: Gerrit Review:

QtAsyncio: Add documentation page: Gerrit Review:

doc: Update copyright year to 2024: Gerrit Review:

Documentation: Link the Qt Linguist and GNU gettext examples: Gerrit Review:

Documentation: Link the Qt Linguist and GNU gettext examples: Gerrit Review:

Link more tools from the package details page: Gerrit Review:

Link more tools from the package details page: Gerrit Review:

Add documentation on pyside6-project: Gerrit Review:

Add documentation on pyside6-project: Gerrit Review:

shiboken6: Restructure documentation on modifying functions: Gerrit Review:

shiboken6: Restructure documentation on modifying functions: Gerrit Review:

Complete module documentation for 6.7: Gerrit Review:

Update module documentation for 6.7: Gerrit Review:

Documentation: Remove C++ example documents from the additional pages list: Gerrit Review:

Documentation: Remove C++ example documents from the additional pages list: Gerrit Review:

Complete module documentation for 6.7: Gerrit Review:

Update module documentation for 6.7: Gerrit Review:

Update API (front page) module documentation: Gerrit Review: