From 68ceeb4567eeffd6bfd0525de7a763ff79bfc7c0 Mon Sep 17 00:00:00 2001 From: Moritz Schreiber <68053396+mosc9575@users.noreply.github.com> Date: Mon, 17 Nov 2025 11:11:40 +0100 Subject: [PATCH 1/4] move Makefile --- doc/{src => }/Makefile | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) rename doc/{src => }/Makefile (65%) diff --git a/doc/src/Makefile b/doc/Makefile similarity index 65% rename from doc/src/Makefile rename to doc/Makefile index 9a43d2644..86c5cf88b 100644 --- a/doc/src/Makefile +++ b/doc/Makefile @@ -4,18 +4,16 @@ # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build -SPHINXPROJ = mpisppy -SOURCEDIR = . -BUILDDIR = _build +SOURCEDIR = src +BUILDDIR = build + +.PHONY: help Makefile # Put it first so that "make" without argument is like "make help". help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -.PHONY: help Makefile + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" # Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - From 6fae9bd98f636a5e2eb35f929b1e849d10f20427 Mon Sep 17 00:00:00 2001 From: Moritz Schreiber <68053396+mosc9575@users.noreply.github.com> Date: Mon, 17 Nov 2025 11:11:54 +0100 Subject: [PATCH 2/4] add make.bat for Windows users --- doc/make.bat | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 doc/make.bat diff --git a/doc/make.bat b/doc/make.bat new file mode 100644 index 000000000..ff59607d3 --- /dev/null +++ b/doc/make.bat @@ -0,0 +1,29 @@ +@ECHO OFF + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +if "%BUILDDIR%" == "" ( + set BUILDDIR=build +) +if "%SOURCEDIR%" == "" ( + set SOURCEDIR=src +) + +if "%1" == "" goto help + +if "%1" == "help" ( + :help + %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% + + goto end +) else ( + echo. %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% + %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + + goto end +) + +:end From c39f5ad9faa73372f2877d568f171d1f575949ce Mon Sep 17 00:00:00 2001 From: Moritz Schreiber <68053396+mosc9575@users.noreply.github.com> Date: Mon, 17 Nov 2025 11:26:27 +0100 Subject: [PATCH 3/4] Update doc/make.bat --- doc/make.bat | 1 - 1 file changed, 1 deletion(-) diff --git a/doc/make.bat b/doc/make.bat index ff59607d3..12bb85973 100644 --- a/doc/make.bat +++ b/doc/make.bat @@ -20,7 +20,6 @@ if "%1" == "help" ( goto end ) else ( - echo. %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% goto end From 83076d3334d9ba6471c615621588f0bf3d60bd82 Mon Sep 17 00:00:00 2001 From: Moritz Schreiber <68053396+mosc9575@users.noreply.github.com> Date: Mon, 17 Nov 2025 11:47:06 +0100 Subject: [PATCH 4/4] change path to run doctest --- .github/workflows/test_pr_and_main.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/test_pr_and_main.yml b/.github/workflows/test_pr_and_main.yml index 9a220f855..5622a8724 100644 --- a/.github/workflows/test_pr_and_main.yml +++ b/.github/workflows/test_pr_and_main.yml @@ -90,7 +90,7 @@ jobs: - name: Test docs run: | - cd ./doc/src/ + cd ./doc/ make doctest runall_persistent: