Skip to content

Commit

Permalink
In the documentation, fix some formatting issues in the attributes/at…
Browse files Browse the repository at this point in the history
…tributes and methods/methods sections using autodoc.
  • Loading branch information
HaudinFlorence committed Apr 6, 2022
1 parent b2df257 commit 02113a2
Show file tree
Hide file tree
Showing 8 changed files with 22 additions and 26 deletions.
4 changes: 2 additions & 2 deletions docs/source/controls/draw_control.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ Example

m

Attributes
----------
Methods
-------

.. autoclass:: ipyleaflet.leaflet.DrawControl
:members:
4 changes: 2 additions & 2 deletions docs/source/controls/legend_control.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ Example
legend.position = "topright" # Set position
legend.position # Get current position

Attributes
----------
Attributes and methods
----------------------

.. autoclass:: ipyleaflet.leaflet.LegendControl
:members:
4 changes: 2 additions & 2 deletions docs/source/controls/measure_control.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ Example
m


Attributes
----------
Attributes and methods
----------------------

.. autoclass:: ipyleaflet.leaflet.MeasureControl
:members:
2 changes: 1 addition & 1 deletion docs/source/controls/search_control.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ You can also search features from GeoJSON layers.

m

Methods
Attributes and methods
-------

.. autoclass:: ipyleaflet.leaflet.SearchControl
Expand Down
4 changes: 2 additions & 2 deletions docs/source/layers/layer_group.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ Example
m


Attributes
----------
Attributes and methods
----------------------

.. autoclass:: ipyleaflet.leaflet.LayerGroup
:members:
4 changes: 2 additions & 2 deletions docs/source/layers/popup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ Example
m


Attributes
----------
Attributes and methods
----------------------

.. autoclass:: ipyleaflet.leaflet.Popup
:members:
4 changes: 2 additions & 2 deletions docs/source/layers/vector_tile.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,8 @@ Example
m


Attributes
----------
Attributes and methods
----------------------

.. autoclass:: ipyleaflet.leaflet.VectorTileLayer
:members:
22 changes: 9 additions & 13 deletions ipyleaflet/leaflet.py
Original file line number Diff line number Diff line change
Expand Up @@ -1060,7 +1060,7 @@ class LayerGroup(Layer):
A group of layers that you can put on the map like other layers.
Attributes and methods
Attributes
----------
layers: list, default []
List of layers to include in the group.
Expand Down Expand Up @@ -1144,7 +1144,7 @@ class GeoJSON(FeatureGroup):
Layer created from a GeoJSON data structure.
Attributes and methods
Attributes
----------
data: dict, default {}
The JSON data structure.
Expand Down Expand Up @@ -1524,20 +1524,16 @@ class MeasureControl(Control):
A control which allows making measurements on the Map.
Attributes and methods
----------
Attributes
----------------------
primary_length_unit: str, default 'feet'
Possible values are 'feet', 'meters', 'miles', 'kilometers' or any user
defined unit.
Possible values are 'feet', 'meters', 'miles', 'kilometers' or any user defined unit.
secondary_length_unit: str, default None
Possible values are 'feet', 'meters', 'miles', 'kilometers' or any user
defined unit.
Possible values are 'feet', 'meters', 'miles', 'kilometers' or any user defined unit.
primary_area_unit: str, default 'acres'
Possible values are 'acres', 'hectares', 'sqfeet', 'sqmeters', 'sqmiles'
or any user defined unit.
Possible values are 'acres', 'hectares', 'sqfeet', 'sqmeters', 'sqmiles' or any user defined unit.
secondary_area_unit: str, default None
Possible values are 'acres', 'hectares', 'sqfeet', 'sqmeters', 'sqmiles'
or any user defined unit.
Possible values are 'acres', 'hectares', 'sqfeet', 'sqmeters', 'sqmiles' or any user defined unit.
active_color: CSS Color, default '#ABE67E'
The color used for current measurements.
completed_color: CSS Color, default '#C8F2BE'
Expand Down Expand Up @@ -1915,7 +1911,7 @@ def remove_legend_element(self, key):
class SearchControl(Control):
""" SearchControl class, with Control as parent class.
Attributes and methods
Attributes
----------
url: string, default ""
Expand Down

0 comments on commit 02113a2

Please sign in to comment.