Updated docs

Author: PierreRaybaut

CHANGELOG.md

@@ -8,9 +8,9 @@
   * Added `is_connected` method
 
 * New `widgets` module:
-  * New `DataLabConnectionDialog` class:
+  * New `ConnectionDialog` class:
     * Ready-to-use dialog box to connect to a DataLab server
-    * `from cdlclient.widgets import DataLabConnectionDialog`
+    * `from cdlclient.widgets import ConnectionDialog`
     * See example in `cdlclient/tests/connect_dialog.py`
 
 ## Version 0.4.0 ##

cdlclient/tests/connect_dialog.py

@@ -10,17 +10,21 @@
 # guitest: show
 
 from guidata.qthelpers import qt_app_context
+from qtpy import QtWidgets as QW
 
 from cdlclient import SimpleRemoteProxy
-from cdlclient.widgets import DataLabConnectionDialog
+from cdlclient.widgets import ConnectionDialog
 
 
 def test_dialog():
     """Test connection dialog"""
     proxy = SimpleRemoteProxy()
     with qt_app_context():
-        dlg = DataLabConnectionDialog(proxy.connect)
-        dlg.exec()
+        dlg = ConnectionDialog(proxy.connect)
+        if dlg.exec():
+            QW.QMessageBox.information(None, "Connection", "Successfully connected")
+        else:
+            QW.QMessageBox.critical(None, "Connection", "Connection failed")
 
 
 if __name__ == "__main__":

cdlclient/tests/remoteclient_app.py

@@ -25,7 +25,7 @@
 from cdlclient import SimpleRemoteProxy
 from cdlclient.tests.remoteclient_base import AbstractClientWindow
 from cdlclient.tests.remoteclient_unit import multiple_commands
-from cdlclient.widgets import DataLabConnectionDialog
+from cdlclient.widgets import ConnectionDialog
 
 APP_NAME = "Remote client test"
 
@@ -73,7 +73,7 @@ def init_cdl(self):
         """Open DataLab test"""
         if self.cdl is None:
             self.cdl: SimpleRemoteProxy = SimpleRemoteProxy()
-            connect_dlg = DataLabConnectionDialog(self.cdl.connect, self)
+            connect_dlg = ConnectionDialog(self.cdl.connect, self)
             ok = connect_dlg.exec()
             if ok:
                 self.host.log("✨ Initialized DataLab connection ✨")

cdlclient/widgets/__init__.py

@@ -11,4 +11,4 @@
 """
 
 # pylint: disable=unused-import
-from cdlclient.widgets.connection import DataLabConnectionDialog
+from cdlclient.widgets.connection import ConnectionDialog

cdlclient/widgets/connection.py

@@ -43,7 +43,7 @@ def run(self) -> None:
             self.SIG_CONNECTION_KO.emit()
 
 
-class DataLabConnectionDialog(QW.QDialog):
+class ConnectionDialog(QW.QDialog):
     """DataLab Connection dialog
 
     Args:
@@ -125,5 +125,5 @@ def fake_connect():
         # raise ConnectionRefusedError("Connection refused")
 
     with qt_app_context():
-        dlg = DataLabConnectionDialog(fake_connect)
+        dlg = ConnectionDialog(fake_connect)
         dlg.exec()

doc/api.rst

@@ -28,3 +28,9 @@ objects.
 
 .. autoclass:: cdlclient.simplemodel.ImageObj
     :members:
+
+Connection dialog
+^^^^^^^^^^^^^^^^^
+
+.. autoclass:: cdlclient.widgets.ConnectionDialog
+    :members:

doc/images/shots/connect_dialog.png

@@ -13,6 +13,10 @@ DataLab Simple Client (``cdlclient`` package) is a Python library providing a
 remote proxy to a DataLab application (server). It allows to use DataLab
 features from a remote computer, and/or from a third-party application.
 
+It also provides widgets to embed DataLab features in a Qt application
+(connection dialog, etc.). For this particular use case, the library relies
+on `QtPy`_.
+
 .. figure:: _static/plotpy-stack-powered.png
     :align: center
 
@@ -44,6 +48,7 @@ Copyrights and licensing
 .. _PlotPyStack: https://github.com/PlotPyStack
 .. _guidata: https://pypi.python.org/pypi/guidata
 .. _PlotPy: https://pypi.python.org/pypi/PlotPy
+.. _QtPy: https://pypi.python.org/pypi/QtPy
 .. _PyPI: https://pypi.python.org/pypi/DataLab
 .. _Home: https://github.com/Codra-Ingenierie-Informatique/DataLabSimpleClient/
 .. _Documentation: https://cdlapp.readthedocs.io/

doc/index.rst

@@ -85,3 +85,19 @@ class (on the section "Remote control").
 .. _XML-RPC: https://docs.python.org/3/library/xmlrpc.html
 
 .. _Spyder: https://www.spyder-ide.org/
+
+
+Connection dialog
+^^^^^^^^^^^^^^^^^
+
+The DataLab Simple Client package provides a connection dialog that may be used
+to connect to a running DataLab instance. It is exposed by the
+:py:class:`cdlclient.widgets.ConnectionDialog` class.
+
+.. figure:: /images/shots/connect_dialog.png
+
+    Screenshot of connection dialog (``cdlclient.widgets.ConnectionDialog``)
+
+Example of use:
+
+.. literalinclude:: ../cdlclient/tests/connect_dialog.py

doc/overview.rst

@@ -18,6 +18,8 @@ cd %SCRIPTPATH%\..
 set PATH=C:\Program Files\HTML Help Workshop;C:\Program Files (x86)\HTML Help Workshop;%PATH%
 sphinx-build -b latex doc build\doc
 cd build\doc
-pdflatex %LIBNAME%.tex
+pdflatex -interaction=nonstopmode -quiet %LIBNAME%.tex
+@REM Build again to fix table of contents
+pdflatex -interaction=nonstopmode -quiet %LIBNAME%.tex
 start %LIBNAME%.pdf
 call %FUNC% EndOfScript