diff options
author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2022-03-15 08:14:51 +0100 |
---|---|---|
committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2022-03-16 07:59:29 +0100 |
commit | 8fb276b5d8436e2ec84e1b9d3f24a77fb2863017 (patch) | |
tree | 2edd6065bf1685ee28830ceccccd1feaf78ead83 /sources/pyside6/doc/extras/QtNetwork.rst | |
parent | 8b79b1ce2cb0353c85919600a1ff269e56a537e6 (diff) |
PySide6/Documentation: Add module descriptions
Add module descriptions and a README.md on how to create them.
Pick-to: 6.2
Change-Id: I627205843bedd74e625d14da718e42faac0a2c68
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Diffstat (limited to 'sources/pyside6/doc/extras/QtNetwork.rst')
-rw-r--r-- | sources/pyside6/doc/extras/QtNetwork.rst | 27 |
1 files changed, 26 insertions, 1 deletions
diff --git a/sources/pyside6/doc/extras/QtNetwork.rst b/sources/pyside6/doc/extras/QtNetwork.rst index 070ab77f7..18d8b3db2 100644 --- a/sources/pyside6/doc/extras/QtNetwork.rst +++ b/sources/pyside6/doc/extras/QtNetwork.rst @@ -1,5 +1,30 @@ -To include the definitions of the module's classes, use the following directive: +Provides networking capabilities + +The Qt Network module provides a set of APIs for programming applications that +use TCP/IP. Operations such as requests, cookies, and sending data over HTTP +are handled by various Python classes. + +Using the Module +^^^^^^^^^^^^^^^^ + +To include the definitions of modules classes, use the following +directive: :: import PySide6.QtNetwork + +Articles and Guides +^^^^^^^^^^^^^^^^^^^ + +These articles contain information about Qt Network setup and about applications with networking capabilities. + + + * :ref:`Network Programming with Qt<Network-Programming-with-Qt>` - Programming applications + with networking capabilities + * :ref:`Secure Sockets Layer (SSL) Classes<Secure-Sockets-Layer--SSL--Classes>` - Classes + for secure communication over network sockets + +Also note shipping OpenSSL might cause +`Import and Export Restrictions <https://doc.qt.io/qt-6/ssl.html#import-and-export-restrictions>`_ +to apply. |