From 019ff419cd98c522503fa1f9b5b58d7b0b2ee648 Mon Sep 17 00:00:00 2001 From: RohitP2005 <rohitprivate13@gmail.com> Date: Sun, 22 Dec 2024 18:33:33 +0530 Subject: [PATCH 1/3] Added a warning admonition in docs --- docs/source/user_guide/installation/index.rst | 24 +++++++++++-------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/docs/source/user_guide/installation/index.rst b/docs/source/user_guide/installation/index.rst index 4c493d6ee4..7c98632722 100644 --- a/docs/source/user_guide/installation/index.rst +++ b/docs/source/user_guide/installation/index.rst @@ -45,6 +45,10 @@ Dependencies ------------ .. _install.required_dependencies: +.. warning:: + + The list of dependencies below may be outdated. Please refer to the official repository or package manager for the most up-to-date versions. + Required dependencies ~~~~~~~~~~~~~~~~~~~~~ @@ -53,16 +57,16 @@ PyBaMM requires the following dependencies. =================================================================== ========================== Package Minimum supported version =================================================================== ========================== -`NumPy <https://numpy.org>`__ 1.23.5 -`SciPy <https://docs.scipy.org/doc/scipy/>`__ 1.9.3 -`CasADi <https://web.casadi.org/docs/>`__ 3.6.3 -`Xarray <https://docs.xarray.dev/en/stable/>`__ 2022.6.0 -`Anytree <https://anytree.readthedocs.io/en/stable/>`__ 2.8.0 -`SymPy <https://docs.sympy.org/latest/index.html>`__ 1.9.3 -`typing-extensions <https://pypi.org/project/typing-extensions/>`__ 4.10.0 -`pandas <https://pypi.org/project/pandas/>`__ 1.5.0 -`pooch <https://www.fatiando.org/pooch/>`__ 1.8.1 -`posthog <https://posthog.com/>`__ 3.6.5 +`NumPy <https://numpy.org>`__ 1.23.5 +`SciPy <https://docs.scipy.org/doc/scipy/>`__ 1.9.3 +`CasADi <https://web.casadi.org/docs/>`__ 3.6.3 +`Xarray <https://docs.xarray.dev/en/stable/>`__ 2022.6.0 +`Anytree <https://anytree.readthedocs.io/en/stable/>`__ 2.8.0 +`SymPy <https://docs.sympy.org/latest/index.html>`__ 1.9.3 +`typing-extensions <https://pypi.org/project/typing-extensions/>`__ 4.10.0 +`pandas <https://pypi.org/project/pandas/>`__ 1.5.0 +`pooch <https://www.fatiando.org/pooch/>`__ 1.8.1 +`posthog <https://posthog.com/>`__ 3.6.5 `pyyaml <https://pyyaml.org/>`__ `platformdirs <https://platformdirs.readthedocs.io/en/latest/>`__ =================================================================== ========================== From ab95afa9ad66a402b71fd679c92975d7b96058b9 Mon Sep 17 00:00:00 2001 From: RohitP2005 <rohitprivate13@gmail.com> Date: Sun, 22 Dec 2024 19:45:01 +0530 Subject: [PATCH 2/3] Updated the warning msg --- docs/source/user_guide/installation/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/user_guide/installation/index.rst b/docs/source/user_guide/installation/index.rst index 7c98632722..889154f9b2 100644 --- a/docs/source/user_guide/installation/index.rst +++ b/docs/source/user_guide/installation/index.rst @@ -47,7 +47,7 @@ Dependencies .. warning:: - The list of dependencies below may be outdated. Please refer to the official repository or package manager for the most up-to-date versions. + The list of dependencies below might be outdated. Please refer to the pyproject.toml file to find all dependencies. Required dependencies ~~~~~~~~~~~~~~~~~~~~~ From ad504482f36efa7c55270b20a219de5765c3ea4b Mon Sep 17 00:00:00 2001 From: RohitP2005 <rohitprivate13@gmail.com> Date: Sun, 22 Dec 2024 20:12:23 +0530 Subject: [PATCH 3/3] Add quotes for the project.toml --- docs/source/user_guide/installation/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/user_guide/installation/index.rst b/docs/source/user_guide/installation/index.rst index 889154f9b2..8920f3f35e 100644 --- a/docs/source/user_guide/installation/index.rst +++ b/docs/source/user_guide/installation/index.rst @@ -47,7 +47,7 @@ Dependencies .. warning:: - The list of dependencies below might be outdated. Please refer to the pyproject.toml file to find all dependencies. + The list of dependencies below might be outdated. Please refer to the ``pyproject.toml`` file to find all dependencies. Required dependencies ~~~~~~~~~~~~~~~~~~~~~