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. 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 `