You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/content/usage.rst
+4-7Lines changed: 4 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -63,19 +63,16 @@ Start the graphical user interface.
63
63
64
64
.. code:: bash
65
65
66
-
figeno gui [-m MODE] [-p PORT] [--debug]
66
+
figeno gui [--webview] [-p PORT] [--debug]
67
67
68
68
Parameters:
69
69
70
-
* ``-m``, ``--mode``. Can be "auto" (default), "browser" or "webview". Browser will start a local server which can be viewed in a web browser (at localhost:5000 by default) while webview will open the gui in a separate window using pywebview. If "auto", will use browser for linux and webview for windows and mac.
70
+
* ``-w``, ``--webview``. If set, will use pywebview to render the GUI. Otherwise, the GUI can be viewed in the browser (at localhost:5000 by default).
71
71
72
72
* ``-p``, ``--port``. Port for the local server, in case the browser mode is used (default: 5000).
73
73
74
-
* ``--debug``: if set, will print more information to the terminal.
74
+
* ``--debug``: If set, will print more information to the terminal.
75
75
76
-
.. warning::
77
-
The browser mode for is currently only supported for linux.
78
-
79
76
.. warning::
80
77
The webview mode works for linux, windows and mac, but for linux you will need to install additional dependencies (see https://pywebview.flowrl.com/guide/installation.html#linux).
81
78
@@ -96,7 +93,7 @@ You can also import figeno as a python module, and give ``figeno_make`` the conf
help="The GUI can either be viewed in a browser tab (--mode browser) or in a separate webview window (--mode webview).\
21
-
By default (--mode auto), will select browser for linux and webview for windows and mac.")
13
+
parser.add_argument('-w','--webview', dest="webview",action='store_true',help="If set, start the GUI in webview (using pywebview) instead of in the browser..")
22
14
parser.add_argument("-p","--port",type=int,default=5000, help="Port, only used in browser mode.")
23
15
parser.add_argument('--debug', action='store_true',help="If set, will provide more debugging information.")
0 commit comments