From 6ff18685bf7e13b58de21cf24afea6c36dc06dc7 Mon Sep 17 00:00:00 2001 From: Conengmo <33519926+Conengmo@users.noreply.github.com> Date: Wed, 27 Nov 2024 16:46:08 +0100 Subject: [PATCH 1/2] docs: add OverlappingMarkerSpiderfier to table --- docs/user_guide/plugins.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/user_guide/plugins.rst b/docs/user_guide/plugins.rst index 947a1ea35..8197f6ff2 100644 --- a/docs/user_guide/plugins.rst +++ b/docs/user_guide/plugins.rst @@ -81,6 +81,8 @@ Plugins - A small minimap showing the map at a different scale to aid navigation. * - :doc:`Mouse Position ` - A control that displays geographic coordinates of the mouse pointer, as it is moved over the map. + * - :doc:`Overlapping Marker Spiderifier ` + - Help manage overlapping markers by “spiderfying” them when clicked, making it easier to select individual markers. * - :doc:`Pattern ` - Add support for pattern fills on Paths. * - :doc:`Polygon Encoded ` From e2c96ed4f56348118c0fdf10325d8fd83bff6acb Mon Sep 17 00:00:00 2001 From: Conengmo <33519926+Conengmo@users.noreply.github.com> Date: Wed, 27 Nov 2024 16:47:48 +0100 Subject: [PATCH 2/2] update plugin docs requirements --- .github/CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index fd2bbdadd..e9b675123 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -116,8 +116,10 @@ The *final* PR should contain: - a new module in `folium/plugins` with the plugin class, with docstring - importing that class in `folium/plugins/__init__.py` - a test in `tests/plugins/test_[new plugin module].py` -- listing the plugin in `docs/user_guide/plugins.rst` - a documentation module with examples in `docs/user_guide/plugins` +- listing that module in `docs/user_guide/plugins.rst` + - in the toctree + - as well as the table lower on the page Before doing all this work it's a good idea to open a PR with just the plugin to discuss whether it's something to include in folium.