From b8ea2fb18c6994f9a55d28ea6d7b2e235a417077 Mon Sep 17 00:00:00 2001 From: Venugopal Shivashankar Date: Thu, 24 Oct 2019 14:59:56 +0200 Subject: Doc: Add the additional and the API ref pages to the toctree The breadcrumb does not work as expected without these pages in the toctree. In addition, changed the module page links to use the :mod: directive instead of the :doc:. Change-Id: I0fc86ae0026375d4924b870c5e20c504aea3aed1 Reviewed-by: Cristian Maureira-Fredes --- sources/pyside2/doc/contents.rst | 1 + sources/pyside2/doc/index.rst | 28 ++++++------- sources/pyside2/doc/modules.rst | 87 ++++++++++++++++++++++------------------ sources/pyside2/doc/overview.rst | 14 +++++++ 4 files changed, 76 insertions(+), 54 deletions(-) (limited to 'sources/pyside2/doc') diff --git a/sources/pyside2/doc/contents.rst b/sources/pyside2/doc/contents.rst index 675a5b73a..c4867f250 100644 --- a/sources/pyside2/doc/contents.rst +++ b/sources/pyside2/doc/contents.rst @@ -11,6 +11,7 @@ deployment.rst pysideapi2.rst licenses.rst + modules.rst Module Index ============ diff --git a/sources/pyside2/doc/index.rst b/sources/pyside2/doc/index.rst index b0bb1d19c..acc1d6d40 100644 --- a/sources/pyside2/doc/index.rst +++ b/sources/pyside2/doc/index.rst @@ -24,23 +24,23 @@ Basic modules ------------- These are the main modules that will help you build a Widget based UI. - `Qt Core `_ + :mod:`Qt Core ` Provides core non-GUI functionality, like signal and slots, properties, base classes of item models, serialization, etc. - `Qt Gui `_ + :mod:`Qt Gui ` Extends QtCore with GUI functionality: Events, windows and screens, OpenGL and raster-based 2D painting, images. - `Qt Widgets `_ + :mod:`Qt Widgets ` Ready to use Widgets for your application, including also graphical elements for your UI. QML and Qt Quick ---------------- - If you want to use the `Qml Language `, these + If you want to use the `Qml Language `, these modules will help you interact with it from Python. - `Qt Qml `_ + :mod:`Qt Qml ` Base Python API to interact with the QML module. - `Qt Quick `_ + :mod:`Qt Quick ` Provides classes for embedding Qt Quick in Qt applications. - `Qt QuickWidgets `_ + :mod:`Qt QuickWidgets ` Provides the QQuickWidget class for embedding Qt Quick in widget-based applications. Data visualization @@ -49,9 +49,9 @@ Data visualization Charts, diagrams, animations: these modules provide a large amount of classes that can help you include these elements in your UI. - `Qt Charts `_ + :mod:`Qt Charts ` Provides a set of easy to use chart components. - `Qt DataVisualization `_ + :mod:`Qt DataVisualization ` Provides a way to visualize data in 3D as bar, scatter, and surface graphs. Multimedia @@ -60,9 +60,9 @@ Multimedia Audio, video, and hardware interaction: check these modules if you are looking for multimedia solutions. - `Qt Multimedia `_ + :mod:`Qt Multimedia ` Provides low-level multimedia functionality. - `Qt MultimediaWidgets `_ + :mod:`Qt MultimediaWidgets ` Provides the widget-based multimedia API. WebEngine @@ -71,9 +71,9 @@ WebEngine If your project is based on a browser or the features around web based applications, these modules will help you to interact with them. - `Qt WebEngineWidgets `_ + :mod:`Qt WebEngineWidgets ` Provides widgets that can handle web content. - `Qt WebChannel `_ + :mod:`Qt WebChannel ` Enables peer-to-peer communication between a server and a client (HTML/JavaScript or QML application). @@ -83,5 +83,5 @@ All the modules There are many other modules currently supported by |pymodname|, here you can find a complete list of them. - `Check all the modules `_ + :doc:`Check all the modules ` Display a table with all the currently supported Qt modules. diff --git a/sources/pyside2/doc/modules.rst b/sources/pyside2/doc/modules.rst index 1d6564300..6741b465d 100644 --- a/sources/pyside2/doc/modules.rst +++ b/sources/pyside2/doc/modules.rst @@ -1,94 +1,101 @@ Qt Modules =========== +.. toctree:: + :hidden: + :glob: + + PySide2/Qt** + .. list-table:: :widths: 150, 150 :align: left - * - `Qt Core `_ + * - :mod:`Qt Core ` Provides core non-GUI functionality. - - `Qt 3D Animation `_ + - :mod:`Qt 3D Animation ` Provides basic elements required to animate 3D objects. - * - `Qt Gui `_ + * - :mod:`Qt Gui ` Extends QtCore with GUI functionality. - - `Qt Help `_ + - :mod:`Qt Help ` Provides classes for integrating online documentation in applications. - * - `Qt Network `_ + * - :mod:`Qt Network ` Offers classes that let you to write TCP/IP clients and servers. - - `Qt OpenGL `_ + - :mod:`Qt OpenGL ` Offers classes that make it easy to use OpenGL in Qt applications. - * - `Qt PrintSupport `_ + * - :mod:`Qt PrintSupport ` Provides extensive cross-platform support for printing. - - `Qt Qml `_ + - :mod:`Qt Qml ` Python API for Qt QML. - * - `Qt Charts `_ + * - :mod:`Qt Charts ` Provides a set of easy to use chart components. - - `Qt Quick `_ + - :mod:`Qt Quick ` Provides classes for embedding Qt Quick in Qt applications. - * - `Qt DataVisualization `_ + * - :mod:`Qt DataVisualization ` Provides a way to visualize data in 3D as bar, scatter, and surface graphs. - - `Qt QuickWidgets `_ + - :mod:`Qt QuickWidgets ` Provides the QQuickWidget class for embedding Qt Quick in widget-based applications. - * - `Qt TextToSpeech `_ + * - :mod:`Qt TextToSpeech ` Provides API to access text-to-speech engines. - - `Qt Sql `_ + - :mod:`Qt Sql ` Helps you provide seamless database integration to your Qt applications. - * - `Qt Multimedia `_ + * - :mod:`Qt Multimedia ` Provides low-level multimedia functionality. - - `Qt MultimediaWidgets `_ + - :mod:`Qt MultimediaWidgets ` Provides the widget-based multimedia API. - * - `Qt MacExtras `_ + * - :mod:`Qt MacExtras ` Provides classes and functions specific to macOS and iOS operating systems. - - `Qt Svg `_ + - :mod:`Qt Svg ` Provides classes for displaying the contents of SVG files. - * - `Qt UiTools `_ + * - :mod:`Qt UiTools ` Provides classes to handle forms created with Qt Designer. - - `Qt Test `_ + - :mod:`Qt Test ` Provides classes for unit testing Qt applications and libraries. - * - `Qt Concurrent `_ + * - :mod:`Qt Concurrent ` Provides high-level APIs that make it possible to write multi-threaded programs without using low-level threading primitives such as mutexes, read-write locks, wait conditions, or semaphores. - - `Qt AxContainer `_ + - :mod:`Qt AxContainer ` Provides QAxObject and QAxWidget which act as containers for COM objects and ActiveX controls. - * - `Qt WebEngineCore `_ + * - :mod:`Qt WebEngineCore ` Provides the core functionality to integrate web content. - - `Qt WebEngineWidgets `_ + - :mod:`Qt WebEngineWidgets ` Provides widgets that can handle web content. - * - `Qt WebChannel `_ + * - :mod:`Qt WebChannel ` Enables peer-to-peer communication between a server and a client (HTML/JavaScript or QML application). - - `Qt WebSockets `_ + - :mod:`Qt WebSockets ` Provides interfaces that enable Qt applications to act as a server that can process WebSocket requests, or a client that can consume data received from the server, or both. - * - `Qt Widgets `_ + * - :mod:`Qt Widgets ` Extends Qt GUI with C++ widget functionality. - - `Qt WinExtras `_ + - :mod:`Qt WinExtras ` Provides classes and functions for using some Windows APIs in a Qt way. - * - `Qt X11Extras `_ + * - :mod:`Qt X11Extras ` Provides information about the X display configuration. - - `Qt Xml `_ + - :mod:`Qt Xml ` Provides C++ implementations of SAX and DOM. - * - `Qt XmlPatterns `_ + * - :mod:`Qt XmlPatterns ` Provides support for XPath, XQuery, XSLTi, and XML Schema validation. - - `Qt 3D Core `_ + - :mod:`Qt 3D Core ` Contains functionality to support near-realtime simulation systems. - * - `Qt 3D Extras `_ + * - :mod:`Qt 3D Extras ` Provides a set of prebuilt elements to help you get started with Qt 3D. - - `Qt 3D Input `_ + - :mod:`Qt 3D Input ` Provides classes for handling user input in applications using Qt 3D. - * - `Qt 3D Logic `_ + * - :mod:`Qt 3D Logic ` Enables synchronizing frames with the Qt 3D backend. - - `Qt 3D Render `_ + - :mod:`Qt 3D Render ` Contains functionality to support 2D and 3D rendering using Qt 3D. - * - `Qt Positioning `_ + * - :mod:`Qt Positioning ` Provides positioning information via QML and Python interfaces. - - `Qt Location `_ + - :mod:`Qt Location ` Helps you create viable mapping solutions using the data available from some of the popular location services. - * - `Qt Sensors `_ + * - :mod:`Qt Sensors ` Provides access to sensor hardware via QML and Python interfaces and a motion gesture recognition API for devices. - - `Qt Scxml `_ + - :mod:`Qt Scxml ` Provides classes to create and use state machines from SCXML files. + diff --git a/sources/pyside2/doc/overview.rst b/sources/pyside2/doc/overview.rst index e8a8ace00..86c3a54fe 100644 --- a/sources/pyside2/doc/overview.rst +++ b/sources/pyside2/doc/overview.rst @@ -40,3 +40,17 @@ A simple Hello World example in PySide2 looks like this: label = QLabel("Hello World") label.show() sys.exit(app.exec_()) + + +Additional overviews +-------------------- + +These additional topics provide detailed information about +several Qt-specific features: + +.. toctree:: + :titlesonly: + :glob: + + overviews/* + -- cgit v1.2.3