changeset 1041:fe9c92d81082

note about python
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 08 Mar 2024 16:33:42 +0100
parents 16e4ee083319
children 61e0e5372e72
files Sphinx/source/plugins/python.rst
diffstat 1 files changed, 6 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/Sphinx/source/plugins/python.rst	Tue Mar 05 12:29:11 2024 +0100
+++ b/Sphinx/source/plugins/python.rst	Fri Mar 08 16:33:42 2024 +0100
@@ -250,6 +250,11 @@
 usage of the Python interpreter every second.
   
 
+.. warning::
+   Never call your Python plugin ``orthanc.py``! Otherwise, your plugin will
+   conflict with the ``orthanc`` module that is installed at runtime.
+
+
 Samples
 -------
 
@@ -1051,7 +1056,7 @@
                     :language: python
 
 
-**Example 2**: On a Windows system, consider that you have created a virtual environment in ``C:/tmp/.venv/``.
+**Example 3**: On a Windows system, consider that you have created a virtual environment in ``C:/tmp/.venv/``.
 Instead of defining ``sys.path`` from scratch, it is possible to simply insert the venv-packages in
 the ``sys.path``.  By adding the ``venv`` to an early index (``0``), any package required by your code 
 will be looked up in the ``venv`` first.  And, as a consequence, if the package is not present, the system-wide