SEBSERV-502 deprecation note

.readthedocs.yaml

@@ -0,0 +1,35 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "20"
+    # rust: "1.70"
+    # golang: "1.20"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  # builder: "dirhtml"
+  # Fail on all warnings to avoid broken references
+  # fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#   - pdf
+#   - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+   - requirements: docs/requirements.txt

docs/conf.py

@@ -43,7 +43,7 @@ extensions = [
     'sphinx.ext.todo',
     'sphinx.ext.imgmath',
     'sphinx.ext.viewcode',
-    'sphinx.ext.githubpages',
+    'sphinx.ext.githubpages'
 ]
 
 # Add any paths that contain templates here, relative to this directory.

docs/exam_proctoring.rst

@@ -3,6 +3,14 @@
 Optional Live Proctoring
 ========================
 
+.. attention::
+
+    Deprecation
+
+    The SEB Server live proctoring integration with Zoom and Jitsi Meet will be deprecated within the next upcoming version of SEB Server 1.6.
+
+    This means live proctoring is still available for dedicated SEB versions, but not actively maintained and supported any more.
+
 Live proctoring is a new and yet experimental feature of SEB and SEB Server. The feature is fully optional and not enabled by default.
 The main goal of the live proctoring feature is to support the integration
 of an external meeting service like Jitsi Meet or Zoom for example, within a SEB and SEB Server setup for an exam.

docs/lmssetup.rst

@@ -66,7 +66,7 @@ SEB Server internally. Use the **"Type"** selector to specify the type of the LM
   Server tries to make use of the described API's of the Moodle system but there is currently no SEB restriction plugin available that works
   with SEB Server. Note that Moodle integration is implemented partially within SEB Server version 1.1.x. Only the course access feature is implemented and the course restriction feature will come with a future SEB Server release
 
-- **Moodle with SEB Server Plugin**: The `SEB Server Plugin for Moodle <https://github.com/ethz-let/moodle-quizaccess_sebserver>`_ is new and supported by SEB Server since version 1.5.
+- **Moodle with SEB Server Plugin**: The `SEB Server Plugin for Moodle <https://github.com/ethz-let/moodle-quizzaccess_sebserver>`_ is new and supported by SEB Server since version 1.5.
   With this plugin installed on Moodle side, SEB Server is able to more efficiently communicate with Moodle to fetch course data as well as restricting the quiz on Moodle side 
   For SEB only access, using a auto-generated Browser Exam Key (BEK) for SEB restriction. Also the Moodle user name resolving for SEB Server monitoring is less error prone especially
   if Single Sign On some kind of login provider for Moodle is involved. Furthermore the new SEB Server Plugin for Moodle will be constantly extended and improved with new features in the future.
@@ -260,6 +260,6 @@ Install SEB restriction API plugin
     There is a new SEB Server integration plugin for Moodle available since SEB Server 1.5 that can be used with the LMS Setup type Moodle with SEB Server Plugin.
     This Plugin supports and improves all common SEB Server LMS binding features such as Course-Access, SEB Restriction and LMS Session Name Resolving. 
     It is also planed to extend and improve this plugin with new Moodle specific feature for further releases of SEB Server.
-     - `Documentation <https://github.com/ethz-let/moodle-quizaccess_sebserver>`_
-     - `Repository <https://github.com/ethz-let/moodle-quizaccess_sebserver>`_
+     - `Documentation <https://github.com/ethz-let/moodle-quizzaccess_sebserver>`_
+     - `Repository <https://github.com/ethz-let/moodle-quizzaccess_sebserver>`_
 

docs/monitoring.rst

@@ -108,6 +108,14 @@ In the detail view you are also able to use the instructions "Quit SEB Client" a
 Optional Live Proctoring
 ------------------------
 
+.. attention::
+
+    Deprecation
+
+    The SEB Server live proctoring integration with Zoom and Jitsi Meet will be deprecated within the next upcoming version of SEB Server 1.6.
+
+    This means live proctoring is still available for dedicated SEB versions, but not actively maintained and supported any more.
+
 Live proctoring is a new and yet experimental feature of SEB and SEB Server. The feature is fully optional and not enabled by default.
 This section is about the live proctoring on monitoring a running exam and using the optional live proctoring within.
 To configure the optional live proctoring for a specific exam please have a look at `Optional Live Proctoring <https://seb-server.readthedocs.io/en/latest/exam_proctoring.html#sebProctoringSettings>`_ 

docs/requirements.txt

@@ -1,5 +1,5 @@
 docutils<0.18
 sphinx==5.3.0
-sphinx_rtd_theme==1.1.1
+sphinx_rtd_theme==2.0.0
 readthedocs-sphinx-search==0.1.1
 urllib3==1.26.13