[MATLAB-legacy] Add warnings for legacy MATLAB removal

Cantera · Mar 28, 2024 · d740f1b · d740f1b
1 parent 1d2ed5f
commit d740f1b
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 0 deletions.
diff --git a/doc/sphinx/install/conda.md b/doc/sphinx/install/conda.md
@@ -12,6 +12,13 @@ Installing Cantera using Conda can provide the Cantera
 applications written in C++, C, or Fortran 90. There are some exceptions to the
 availability of each interface depending on the operating system and Conda channel used.
 
+:::{attention}
+The *legacy* Matlab Cantera interface is discontinued and removed in Cantera 3.1. Users
+requiring support of legacy Matlab Cantera code should continue using Cantera 3.0
+packages, or migrate their code base to the experimental Matlab toolbox that is
+currently under development.
+:::
+
 Both the Anaconda and Miniconda distributions are available for Linux, macOS (Intel and
 ARM/Apple Silicon), and Windows. On Windows, users should install a 64-bit version of
 Anaconda or Miniconda, since the Cantera Conda packages are only available for 64-bit

diff --git a/doc/sphinx/install/index.md b/doc/sphinx/install/index.md
@@ -39,6 +39,15 @@ We highly recommend that all new users install the Python interface using
 - Users of other Linux distributions should
   [compile Cantera from source](sec-compiling).
 
+## Installing the Cantera Matlab Toolbox
+
+:::{attention}
+The *legacy* Matlab Cantera interface is discontinued and removed in Cantera 3.1. Users
+requiring support of legacy Matlab Cantera code should continue using Cantera 3.0
+packages, or migrate their code base to the experimental Matlab toolbox that is
+currently under development.
+:::
+
 ```{toctree}
 :maxdepth: 1
 :hidden:
@@ -53,6 +62,8 @@ freebsd
 windows
 ```
 
+## Troubleshooting
+
 ```{seealso}
 Check the [FAQ](sec-faq-installation) for solutions to some common installation
 problems.

diff --git a/doc/sphinx/install/windows.md b/doc/sphinx/install/windows.md
@@ -4,6 +4,13 @@
 Windows installers are provided for stable versions of Cantera. These installers
 provide header/library files that can be used to compile C++ applications.
 
+:::{attention}
+The *legacy* Matlab Cantera interface is discontinued and removed in Cantera 3.1. Users
+requiring support of legacy Matlab Cantera code should continue using Cantera 3.0
+packages, or migrate their code base to the experimental Matlab toolbox that is
+currently under development.
+:::
+
 :::{seealso}
 To install the Cantera Python package, see the [pip](pip) or [conda](conda)
 installation instructions. The Python package is required if: