Updated documentation build packages and Docker compose formats for d…

…istributed tests

.readthedocs.yml

@@ -7,9 +7,9 @@ version: 2
 
 # Build using specified Docker image and tools
 build:
-  os: ubuntu-20.04
+  os: ubuntu-22.04
   tools:
-    python: "3.10"
+    python: "3.12"
   jobs:
     pre_install:
       # https://docs.readthedocs.io/en/stable/build-customization.html#avoid-having-a-dirty-git-index

CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [Unreleased]
+
+### Changed
+
+- Updated CI distributed tests to use Docker Compose V2 and Compose file format version 3
+- Updated automatic documentation build to use Sphinx 7.2.6 and Sphinx RTD Theme 2.0.0
+
 ## [1.6.2]
 
 ### Added

CI/docker-compose.yml

@@ -1,4 +1,4 @@
-version: '2'
+version: '3'
 
 services:
   controller:

CI/installation/requirements_doc.txt

@@ -1,4 +1,4 @@
-sphinx == 4.2.0
-sphinx-rtd-theme == 1.0.0
+sphinx == 7.2.6
+sphinx-rtd-theme == 2.0.0
 sphinx-markdown-builder
 sphinx-tabs

CI/run_integration_tests_for_virtual_cluster.sh

@@ -29,7 +29,7 @@ stop_and_remove_cluster() {
     if [ -d $virtual_cluster_dir ]; then
         log "stopping virtual cluster"
         cd $virtual_cluster_dir
-        docker-compose down -v
+        docker compose down -v
         log "successfully stopped virtual cluster"
         log "removing virtual cluster"
         cd ..
@@ -60,7 +60,7 @@ start_cluster() {
     log "starting virtual cluster on $virtual_cluster_dir"
     cd $virtual_cluster_dir
     mkdir -p sync
-    docker-compose up -d
+    docker compose up -d
     fail_on_error "failed to start cluster with docker-compose up"
     log "successfully started virtual cluster"
 }
@@ -76,7 +76,7 @@ wait_for_controller_node_to_finish_startup() {
 wait_for_idle_state_of_server_nodes() {
     log "waiting for idle state of server nodes"
     cd $virtual_cluster_dir
-    while ! docker-compose exec -T controller sinfo |grep "server\[0-1\]" |grep idle >/dev/null; do
+    while ! docker compose exec -T controller sinfo |grep "server\[0-1\]" |grep idle >/dev/null; do
         sleep 1
     done
     log "successfully waited for idle state of server nodes"
@@ -87,7 +87,7 @@ run_tests() {
     local test_files=$(cd $script_dir/src/integration_tests_for_virtual_cluster && ls test_*.py)
     local tests_dir_in_container=/sarus-source/CI/src
     cd $virtual_cluster_dir
-    docker-compose exec --user=docker -T controller bash -c "cd $tests_dir_in_container/integration_tests_for_virtual_cluster && PATH=/opt/sarus/default/bin:\$PATH PYTHONPATH=$tests_dir_in_container:\$PYTHONPATH CMAKE_INSTALL_PREFIX=/opt/sarus/default pytest -v $test_files"
+    docker compose exec --user=docker -T controller bash -c "cd $tests_dir_in_container/integration_tests_for_virtual_cluster && PATH=/opt/sarus/default/bin:\$PATH PYTHONPATH=$tests_dir_in_container:\$PYTHONPATH CMAKE_INSTALL_PREFIX=/opt/sarus/default pytest -v $test_files"
     if [ $? -ne 0 ]; then
         stop_and_remove_cluster
         error "failed to run integration tests in virtual cluster"

doc/conf.py

@@ -69,7 +69,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.