changeset 978:e7a3b3d76f1c

documentation of new options in Python plugin 4.1
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 31 Aug 2023 19:35:02 +0200
parents caf69d2ee070
children caa4d1484627
files Sphinx/source/plugins/python.rst
diffstat 1 files changed, 27 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/Sphinx/source/plugins/python.rst	Wed Aug 30 14:30:40 2023 +0200
+++ b/Sphinx/source/plugins/python.rst	Thu Aug 31 19:35:02 2023 +0200
@@ -214,7 +214,7 @@
 Configuration options
 ---------------------
 
-The only two configuration options that are available for this plugin
+The two main configuration options that are available for this plugin
 are the following:
 
 * ``PythonScript`` indicates where the Python script is located.  If
@@ -223,6 +223,32 @@
 
 * ``PythonVerbose`` is a Boolean value to make the Python interpreter
   verbose.
+
+Consequently, a minimal :ref:`configuration file <configuration>` for
+Orthanc could be::
+
+  {
+    "Plugins" : [ "." ],
+    "PythonScript" : "my-plugin.py",
+    "PythonVerbose" : false
+  }
+
+Starting with release 4.1 of the Python plugin, it is also possible to
+specify the configuration of the plugin in a dedicated ``Python``
+section as follows::
+
+  {
+    "Plugins" : [ "." ],
+    "Python" : {
+      "Path" : "my-plugin.py",  // Alias for the global "PythonScript" option
+      "Verbose" : false,        // Alias for the global "PythonVerbose" option
+      "DisplayMemoryUsage" : false
+    }
+  }
+
+The option ``Python.DisplayMemoryUsage`` was introduced in release 4.1
+of the plugin. If set to ``true``, Orthanc will display the memory
+usage of the Python interpreter every second.
   
 
 Samples