get docs building again by updating sphinx dependencies

.readthedocs.yaml

@@ -8,9 +8,9 @@ sphinx:
     fail_on_warning: true
 
 build:
-  os: "ubuntu-22.04"
+  os: "ubuntu-24.04"
   tools:
-    python: "3.10"
+    python: "3.12"
   apt_packages:
     - iputils-ping
     - build-essential

docs/conf.py

@@ -19,12 +19,18 @@
 
 here = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 sys.path.insert(0, here)
+from pathlib import Path
+
 from buildtest import BUILDTEST_COPYRIGHT, BUILDTEST_VERSION
 from buildtest.cli.buildspec import BuildspecCache
 from buildtest.config import SiteConfiguration
 from buildtest.defaults import BUILDTEST_ROOT, DEFAULT_SETTINGS_FILE, VAR_DIR
 from buildtest.utils.file import is_dir
 
+HERE = Path(__file__).parent
+
+(HERE / "api").mkdir(exist_ok=True)
+
 # set BUILDTEST_ROOT environment that is generally set by 'source setup.sh'
 os.environ["BUILDTEST_ROOT"] = here
 # add $BUILDTEST_ROOT/bin to $PATH to reference 'buildtest' command in docs

docs/requirements.txt

@@ -1,10 +1,10 @@
-docutils==0.20.1
+docutils==0.22.1
 readthedocs-sphinx-search==0.3.2
-sphinx==7.4.7
-sphinx-design==0.5.0
+sphinx==9.0.4
 sphinx-argparse==0.5.2
 sphinx-autoapi==3.0.0
 sphinx-rtd-theme==2.0.0
 sphinxcontrib-programoutput==0.17
 sphinxext-remoteliteralinclude==0.4.0
 sphinx-copybutton==0.5.2
+sphinx-design==0.7.0

docs/writing_buildspecs/multi_executor.rst

@@ -75,6 +75,8 @@ based on the ``sbatch`` property defined in the ``executors`` field.
 
    .. command-output:: buildtest inspect query -t executors_sbatch_declaration/
 
+.. _cray_burstbuffer_datawarp:
+
 Cray Burst Buffer and Data Warp
 ---------------------------------
 

docs/writing_buildspecs/status_check.rst

@@ -518,11 +518,11 @@ We can confirm the files are not present by checking existence of these files by
 
     .. command-output:: ls -l $HOME/.bashrc_link
         :shell:
-        :returncode: 2
+        :returncode: 1
 
 We can retrieve the full path to stage directory via ``buildtest path -s`` command given the name of test. The **demo** directory is created in stage directory
 so if we run the following command we should see this directory is not present.
 
     .. command-output:: ls -l $(buildtest path -s post_run_example)/demo
         :shell:
-        :returncode: 2
+        :returncode: 1

pyproject.toml

@@ -49,16 +49,16 @@ dev = [
     'yamllint'
 ]
 docs = [
-    "docutils==0.20.1",
+    "docutils==0.22.1",
     "readthedocs-sphinx-search==0.3.2",
-    "sphinx==7.4.7",
-    "sphinx-design==0.5.0",
+    "sphinx==9.0.4",
     "sphinx-argparse==0.5.2",
+    "sphinx-rtd-theme==3.1.0",
     "sphinx-autoapi==3.0.0",
-    "sphinx-rtd-theme==2.0.0",
     "sphinxcontrib-programoutput==0.17",
     "sphinxext-remoteliteralinclude==0.4.0",
-    "sphinx-copybutton==0.5.2"
+    "sphinx-copybutton==0.5.2",
+    "sphinx-design==0.7.0"
 ]
 [tool.black]
 #required-version = '23.3.0'

tutorials/post_run.yml

@@ -5,10 +5,10 @@ buildspecs:
     description: post run example that will remove symbolic link
     run: |
       ln -s $HOME/.bashrc $HOME/.bashrc_link
-      mkdir demo
+      mkdir -v demo
     post_run: |
       unlink $HOME/.bashrc_link
-      rmdir demo
+      rmdir -v demo
     status:
       is_dir:
         - demo