docs: build the sphinx documentation on windows (#1891)

This commit enables building the sphinx documentation on windows.
The make.bat needed to do so was missing and is added in this commit.

To build the documentation from a fresh git clone you need to run these commands:

pixi install
pixi run update-flopy
pixi run get-exes
pixi run setup builddir
pixi run build builddir
pixi run benchmark
pixi run sphinx

Furthermore I added the rtd environment to the pixi.toml. When building sphinx you now don't have to manually pip install the requirements.rtd.txt. Instead the task will automatically use the rtd environment

Finally i updated the github pipeline files. The newly generated pixi.lock is using version 5 which needs a newer pixi version. I also removed the pixi run install as this is no longer required.

Author: Manangka

.build_rtd_docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

.build_rtd_docs/requirements.rtd.txt

@@ -51,7 +51,7 @@ jobs:
 
       - uses: prefix-dev/[email protected]
         with:
-          pixi-version: v0.19.1
+          pixi-version: v0.24.2
 
       - name: Check Fortran source formatting
         run: pixi run check-format
@@ -81,7 +81,7 @@ jobs:
 
       - uses: prefix-dev/[email protected]
         with:
-          pixi-version: v0.19.1
+          pixi-version: v0.24.2
 
       - name: Meson setup
         run: pixi run setup -Dwerror=true builddir
@@ -126,7 +126,7 @@ jobs:
       - name: Setup pixi
         uses: prefix-dev/[email protected]
         with:
-          pixi-version: v0.19.1
+          pixi-version: v0.24.2
           manifest-path: "modflow6/pixi.toml"
 
       - name: Custom pixi install
@@ -225,7 +225,7 @@ jobs:
       - name: Setup pixi
         uses: prefix-dev/[email protected]
         with:
-          pixi-version: v0.19.1
+          pixi-version: v0.24.2
           manifest-path: "modflow6/pixi.toml"
 
       - name: Custom pixi install
@@ -364,7 +364,7 @@ jobs:
       - name: Setup pixi
         uses: prefix-dev/[email protected]
         with:
-          pixi-version: v0.19.1
+          pixi-version: v0.24.2
           manifest-path: "modflow6/pixi.toml"
 
       - name: Custom pixi install
@@ -455,7 +455,7 @@ jobs:
       - name: Setup pixi
         uses: prefix-dev/[email protected]
         with:
-          pixi-version: v0.19.1
+          pixi-version: v0.24.2
           manifest-path: "modflow6/pixi.toml"
 
       - name: Custom pixi install

.github/workflows/ci.yml

@@ -140,7 +140,7 @@ jobs:
       - name: Setup pixi
         uses: prefix-dev/[email protected]
         with:
-          pixi-version: v0.19.1
+          pixi-version: v0.24.2
           manifest-path: "modflow6/pixi.toml"
 
       - name: Custom pixi install

.github/workflows/compilers.yml

@@ -28,7 +28,7 @@ jobs:
 
       - uses: prefix-dev/[email protected]
         with:
-          pixi-version: v0.19.1
+          pixi-version: v0.24.2
 
       - name: Check spelling
         run: pixi run check-spelling
@@ -65,17 +65,13 @@ jobs:
       - name: Setup pixi
         uses: prefix-dev/[email protected]
         with:
-          pixi-version: v0.19.1
+          pixi-version: v0.24.2
           manifest-path: "modflow6/pixi.toml"
 
       - name: Custom pixi install
         working-directory: modflow6
         run: pixi run install
 
-      - name: Install additional packages for Sphinx using pip
-        working-directory: modflow6/.build_rtd_docs
-        run: pixi run pip install -r requirements.rtd.txt
-
       - name: Print python package versions
         working-directory: modflow6
         run: pixi run pip list
@@ -230,7 +226,7 @@ jobs:
       - name: Setup pixi
         uses: prefix-dev/[email protected]
         with:
-          pixi-version: v0.19.1
+          pixi-version: v0.24.2
 
       - name: Custom pixi install
         run: pixi run install

.github/workflows/docs.yml

@@ -69,7 +69,7 @@ jobs:
       - name: Setup pixi
         uses: prefix-dev/[email protected]
         with:
-          pixi-version: v0.19.1
+          pixi-version: v0.24.2
           manifest-path: "modflow6/pixi.toml"
 
       - name: Custom pixi install

.github/workflows/large.yml

@@ -14,7 +14,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: prefix-dev/[email protected]
         with:
-          pixi-version: v0.19.1
+          pixi-version: v0.24.2
           cache: false
 
       - name: Update pixi lock file

.github/workflows/pixi_auto_update.yml

@@ -110,7 +110,7 @@ jobs:
       - name: Setup pixi
         uses: prefix-dev/[email protected]
         with:
-          pixi-version: v0.19.1
+          pixi-version: v0.24.2
           manifest-path: "modflow6/pixi.toml"
 
       - name: Custom pixi install

.github/workflows/release.yml

@@ -20,8 +20,3 @@ sphinx:
 
 # Optionally build your docs in additional formats such as PDF and ePub
 formats: all
-
-# Optionally set the version of Python and requirements required to build your docs
-python:
-  install:
-    - requirements: .build_rtd_docs/requirements.rtd.txt