updated warning message about outdated list of dependencies

[RohitP2005]

Description

This PR updates the warning message for required dependencies in the index.rst file. The previous message was unclear, and this change provides more specific instructions for users. No functional changes were made to the code, only to the documentation for better clarity.

Fixes #<issue_number> (if applicable)

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.

• New feature (non-breaking change which adds functionality)
• Bug fix (non-breaking change which fixes an issue)
• Optimization (back-end change that speeds up the code)

Key checklist:

• [x No style issues: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
• All tests pass: $ python -m pytest (or $ nox -s tests)
• The documentation builds: $ python -m pytest --doctest-plus src (or $ nox -s doctests)

You can run integration tests, unit tests, and doctests together at once, using $ nox -s quick.

Further checks:

• Code is commented, particularly in hard-to-understand areas
• Tests added that prove fix is effective or that feature works

@Saransh-cpp

[RohitP2005]

@Saransh-cpp i guess this includes the changes requested by you.

[arjxn-py]

i guess this includes the changes requested by you.

Hi, a small tip that It is nice to mention in the PR description where this change was originally requested or something like related or follow-up to #xyz :)

[arjxn-py]

Thanks for opening this PR :)
I don't think this is rendering as we want.

[arjxn-py]

Suggested change

	The list of dependencies below might be outdated. Please use tools like [``pipdeptree``](https://github.com/tox-dev/pipdeptree) to find the latest dependencies of ``pybamm``
	The list of dependencies below might be outdated. Please use tools like [`pipdeptree`](https://github.com/tox-dev/pipdeptree) to find the latest dependencies of ``pybamm``

Maybe this?

[agriyakhetarpal]

The PyData Sphinx Theme already adds icons for popular websites including GitHub (as noted in the above screenshot), so we should be fine without rendering Markdown (because this is a docs-only page).

But, I don't recommend using tools like pipdeptree in the first place, since as I mentioned in #4706 (comment), it cannot handle optional dependencies at the moment: tox-dev/pipdeptree#107. Neither can uv pip tree: astral-sh/uv#4710. It is a metadata problem and not an implementation problem: pypa/packaging-problems#215

So, if we are to improve this warning message, we need something better here.

[agriyakhetarpal]

The PyData Sphinx Theme already adds icons for popular websites including GitHub (as noted in the above screenshot), so we should be fine without rendering Markdown (because this is a docs-only page).

But, I don't recommend using tools like pipdeptree in the first place, since as I mentioned in #4706 (comment), it cannot handle optional dependencies at the moment: tox-dev/pipdeptree#107. Neither can uv pip tree: astral-sh/uv#4710. It is a metadata problem and not an implementation problem: pypa/packaging-problems#215

So, if we are to improve this warning message, we need something better here.

[RohitP2005]

I apologies for the confusion caused here .
The pr was requested by @Saransh-cpp at #4706 (comment) despite @agriyakhetarpal suggesting it was not necessary.
I would close the PR if this change is uncessary

[agriyakhetarpal]

I'll be happy to approve if we have something better here. :) We could just say something like,

"Users are advised to manually check the list of dependencies to find out supported versions".

Or, I like SciPy's idea – where they say, "whatever recent versions work": https://docs.scipy.org/doc/scipy/dev/toolchain.html#building-the-documentation, and only enforce or update the lower bound for a dependency only in the case there is a breakage with versions lower than it.

[RohitP2005]

I think this might be good way to put them

[agriyakhetarpal]

Thanks, @RohitP2005! Looks good to me. We should also update the versions as well, while we are at it:

[agriyakhetarpal]

@Saransh-cpp, does this fit your previous suggestion better?

[RohitP2005]

Thanks, @RohitP2005! Looks good to me. We should also update the versions as well, while we are at it:

Happy to help anytime

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.25%. Comparing base (a7253b8) to head (05136e4).
Report is 19 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #4719      +/-   ##
===========================================
+ Coverage    99.22%   99.25%   +0.02%     
===========================================
  Files          303      303              
  Lines        23070    23230     +160     
===========================================
+ Hits         22891    23056     +165     
+ Misses         179      174       -5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[RohitP2005]

@agriyakhetarpal do u think, are there anything else that can be improved here

[agriyakhetarpal]

No more improvements; I'll suggest @Saransh-cpp to review if he finds anything, otherwise, I shall merge.

[arjxn-py]

Thanks @RohitP2005 looks good :)

[Saransh-cpp]

The pr was requested by @Saransh-cpp at #4706 (comment) despite @agriyakhetarpal suggesting it was not necessary.

I agreed to add a link to the file instead of using another tool in my previous review.

[Saransh-cpp]

A link would be great :)

[RohitP2005]

Thanks @Saransh-cpp