diff options
| author | Cristián Maureira-Fredes <cristian.maureira-fredes@qt.io> | 2019-11-26 08:16:03 +0100 |
|---|---|---|
| committer | Cristián Maureira-Fredes <cristian.maureira-fredes@qt.io> | 2019-12-03 10:43:45 +0100 |
| commit | d4764a4c514ec15f4cd680143cbd189482af6251 (patch) | |
| tree | e3ab990446021a30ff00a54769d9a62266a893a2 /sources/pyside2/doc/tutorials | |
| parent | 26404dd4b6c61083bf5de1c1c2208bf2350aba0e (diff) | |
New documentation structure
- New structure for the landing page,
- Some rst were renamed to the new structure,
- New sections "Videos", "Examples" and "Getting Started" were created,
- Information from the wiki was used to create the Getting Started
sections,
- FAQ section was removed,
- Removing pyhtml2devhelp.py since it is unused,
- The new CSS modifications were copied over the Shiboken2 directory.
Task-number: PYSIDE-1067
Change-Id: I1ba53cd0030d6d02449fecdfea70efb49421ad3b
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Reviewed-by: Kavindra Palaraja <kpalaraja@luxoft.com>
Diffstat (limited to 'sources/pyside2/doc/tutorials')
| -rw-r--r-- | sources/pyside2/doc/tutorials/examples/images/tabbedbrowser.png | bin | 37147 -> 0 bytes | |||
| -rw-r--r-- | sources/pyside2/doc/tutorials/examples/tabbedbrowser.rst | 58 | ||||
| -rw-r--r-- | sources/pyside2/doc/tutorials/index.rst | 17 |
3 files changed, 3 insertions, 72 deletions
diff --git a/sources/pyside2/doc/tutorials/examples/images/tabbedbrowser.png b/sources/pyside2/doc/tutorials/examples/images/tabbedbrowser.png Binary files differdeleted file mode 100644 index 27c3daa09..000000000 --- a/sources/pyside2/doc/tutorials/examples/images/tabbedbrowser.png +++ /dev/null diff --git a/sources/pyside2/doc/tutorials/examples/tabbedbrowser.rst b/sources/pyside2/doc/tutorials/examples/tabbedbrowser.rst deleted file mode 100644 index c34c50647..000000000 --- a/sources/pyside2/doc/tutorials/examples/tabbedbrowser.rst +++ /dev/null @@ -1,58 +0,0 @@ -********************** -Web Browser Example -********************** - -The example demonstrates the power and simplicity offered by |project| to developers. -It uses several |pymodname| submodules to offer a fluid and modern-looking UI that -is apt for a web browser. The application offers the following features: - - * Tab-based browsing experience using QTabWidget. - * Download manager using a QProgressBar and QWebEngineDownloadItem. - * Bookmark manager using QTreeView. - -.. image:: images/tabbedbrowser.png - -The application's code is organized in several parts for ease of maintenance. For example, -:code:`DownloadWidget` provides a widget to track progress of a download item. In the following -sections, these different parts are discussed briefly to help you understand the Python code behind -them a little better. - -BookmarkWidget or :code:`bookmarkwidget.py` -=========================================== - -This widget docks to the left of the main window by default. It inherits QTreeView and -loads a default set of bookmarks using a QStandardItemModel. The model is populated at startup -from a JSON file, which is updated when you add or remove bookmarks from the tree view. - -.. automodule:: bookmarkwidget - :members: - -DownloadWidget or :code:`downloadwidget.py` -============================================= - -The widget tracks progress of the download item. It inherits QProgressBar to display -progress of the QWebEngineDownloadItem instance, and offers a context-menu with actions such as Launch, -Show in folder, Cancel, and Remove. - -.. automodule:: downloadwidget - :members: - -BrowserTabWidget or :code:`browsertabwidget.py` -=============================================== - -The widget includes a QWebEngineView to enable viewing web content. It docks to the right -of BookmarkWidget in the main window. - -.. automodule:: browsertabwidget - :members: - -MainWindow or :code:`main.py` -============================= - -This is the parent window that collates all the other widgets together to offer the complete package. - -.. automodule:: main - :members: - - -Try running the example to explore it further. diff --git a/sources/pyside2/doc/tutorials/index.rst b/sources/pyside2/doc/tutorials/index.rst index 5b8fe9361..7486554f9 100644 --- a/sources/pyside2/doc/tutorials/index.rst +++ b/sources/pyside2/doc/tutorials/index.rst @@ -1,23 +1,12 @@ -Qt for Python examples and tutorials -************************************* +|project| Tutorials +==================== -A collection of examples and tutorials with "walkthrough" guides are +A collection of tutorials with "walkthrough" guides are provided with |project| to help new users get started. These documents were ported from C++ to Python and cover a range of topics, from basic use of widgets to step-by-step tutorials that show how an application is put together. -Examples and demos -=================== - -.. toctree:: - :maxdepth: 1 - - examples/tabbedbrowser.rst - ../pyside-examples/all-pyside-examples.rst - -Tutorials -========== .. toctree:: :maxdepth: 2 |
