From 8290a12ed4243dc7b85ef11211cc33ab978b7f4c Mon Sep 17 00:00:00 2001 From: Shahzeb Siddiqui Date: Tue, 7 Jul 2026 09:33:24 -0400 Subject: [PATCH 1/7] update requirements for sphinx and other dependencies to get docs building again --- docs/requirements.txt | 5 ++--- pyproject.toml | 10 +++++----- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 09f577dcc..aa4544a65 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,7 +1,6 @@ -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 diff --git a/pyproject.toml b/pyproject.toml index 46da94939..dced1dbe3 100644 --- a/pyproject.toml +++ b/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' From 586c09c42ac9f805cee3919126812b780d0d4ebe Mon Sep 17 00:00:00 2001 From: Shahzeb Siddiqui Date: Tue, 7 Jul 2026 09:39:32 -0400 Subject: [PATCH 2/7] update requirements.txt file because sphinx-design was not specified --- docs/requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/requirements.txt b/docs/requirements.txt index aa4544a65..ddf2ae9c1 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -7,3 +7,4 @@ 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 \ No newline at end of file From 385c20b7678f168cdba3de76c27588f15363602b Mon Sep 17 00:00:00 2001 From: Shahzeb Siddiqui Date: Tue, 7 Jul 2026 09:41:57 -0400 Subject: [PATCH 3/7] update OS and python version for readthedocs --- .readthedocs.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index e28466d97..1f3d7cf74 100644 --- a/.readthedocs.yaml +++ b/.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 From f263533270fe81a9be2a0e0c418d19147d53f160 Mon Sep 17 00:00:00 2001 From: Shahzeb Siddiqui Date: Tue, 7 Jul 2026 09:50:07 -0400 Subject: [PATCH 4/7] automatically create docs/api directory as part of docs building process --- docs/conf.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index e5eafdcf4..4a345a30e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -24,6 +24,11 @@ from buildtest.config import SiteConfiguration from buildtest.defaults import BUILDTEST_ROOT, DEFAULT_SETTINGS_FILE, VAR_DIR from buildtest.utils.file import is_dir +from pathlib import Path + +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 From 09aa1fc237ce4fc31177e12ef18059a77740fcae Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 7 Jul 2026 13:51:02 +0000 Subject: [PATCH 5/7] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/conf.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 4a345a30e..c1836d45c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,12 +19,13 @@ 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 -from pathlib import Path HERE = Path(__file__).parent From b6526ac0489331cc71ba42e67baf06466e7b7259 Mon Sep 17 00:00:00 2001 From: Shahzeb Siddiqui Date: Tue, 7 Jul 2026 15:56:23 -0400 Subject: [PATCH 6/7] fix an issue with invalid :ref: section in docs that caused a docs build error --- docs/writing_buildspecs/multi_executor.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/writing_buildspecs/multi_executor.rst b/docs/writing_buildspecs/multi_executor.rst index c2cd50e35..b61bf16cb 100644 --- a/docs/writing_buildspecs/multi_executor.rst +++ b/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 --------------------------------- From d1fbe1b104f1120ad7cd9b10a0aecde02b615b89 Mon Sep 17 00:00:00 2001 From: Shahzeb Siddiqui Date: Mon, 20 Jul 2026 15:54:31 -0400 Subject: [PATCH 7/7] fix issue with returncode --- docs/writing_buildspecs/status_check.rst | 4 ++-- tutorials/post_run.yml | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/writing_buildspecs/status_check.rst b/docs/writing_buildspecs/status_check.rst index 1c2a9f33d..52ce34540 100644 --- a/docs/writing_buildspecs/status_check.rst +++ b/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 diff --git a/tutorials/post_run.yml b/tutorials/post_run.yml index 223057bff..211a744e7 100644 --- a/tutorials/post_run.yml +++ b/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