diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..60516d2d --- /dev/null +++ b/.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 \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 8fba51fa..70f190b8 100644 --- a/docs/conf.py +++ b/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. diff --git a/docs/exam_proctoring.rst b/docs/exam_proctoring.rst index e80833cf..cd82a020 100644 --- a/docs/exam_proctoring.rst +++ b/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. diff --git a/docs/monitoring.rst b/docs/monitoring.rst index 554bbbbb..1e868646 100644 --- a/docs/monitoring.rst +++ b/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 `_ diff --git a/docs/requirements.txt b/docs/requirements.txt index eb2a5188..53d44466 100644 --- a/docs/requirements.txt +++ b/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 \ No newline at end of file