BUG: fix html float display
Part of #59876
- [x] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature
- [x] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit).
- [x] Added an entry in the latest `doc/source/whatsnew/v3.0.0.rst` file if fixing a bug or adding a new feature.

Fixes:
- Updated :meth:`DataFrame._repr_html_` to pass the current float format option from :func:`get_option("display.float_format")` to :class:`DataFrameFormatter`, ensuring that the HTML output respects the configured float formatting.


Thanks @saldanhad  Thanks for your help in formatting the tests @mroeschke 