Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions docs/user_guide/plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,8 @@ Plugins
- A small minimap showing the map at a different scale to aid navigation.
* - :doc:`Mouse Position <plugins/mouse_position>`
- A control that displays geographic coordinates of the mouse pointer, as it is moved over the map.
* - :doc:`Overlapping Marker Spiderifier <plugins/overlapping_marker_spiderfier>`
- Help manage overlapping markers by “spiderfying” them when clicked, making it easier to select individual markers.
* - :doc:`Pattern <plugins/pattern>`
- Add support for pattern fills on Paths.
* - :doc:`Polygon Encoded <plugins/polygon_encoded>`
Expand Down
Loading