Skip to content

Commit 41db5bc

Browse files
Merge pull request #959 from HaudinFlorence/docs_correct_attributes_formating
Fix formatting issues in the doc for attributes and methods sections using autodoc
2 parents b2df257 + 02113a2 commit 41db5bc

File tree

8 files changed

+22
-26
lines changed

8 files changed

+22
-26
lines changed

docs/source/controls/draw_control.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ Example
5252

5353
m
5454

55-
Attributes
56-
----------
55+
Methods
56+
-------
5757

5858
.. autoclass:: ipyleaflet.leaflet.DrawControl
5959
:members:

docs/source/controls/legend_control.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ Example
3434
legend.position = "topright" # Set position
3535
legend.position # Get current position
3636

37-
Attributes
38-
----------
37+
Attributes and methods
38+
----------------------
3939

4040
.. autoclass:: ipyleaflet.leaflet.LegendControl
4141
:members:

docs/source/controls/measure_control.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ Example
2828
m
2929

3030

31-
Attributes
32-
----------
31+
Attributes and methods
32+
----------------------
3333

3434
.. autoclass:: ipyleaflet.leaflet.MeasureControl
3535
:members:

docs/source/controls/search_control.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ You can also search features from GeoJSON layers.
7878

7979
m
8080

81-
Methods
81+
Attributes and methods
8282
-------
8383

8484
.. autoclass:: ipyleaflet.leaflet.SearchControl

docs/source/layers/layer_group.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ Example
3232
m
3333

3434

35-
Attributes
36-
----------
35+
Attributes and methods
36+
----------------------
3737

3838
.. autoclass:: ipyleaflet.leaflet.LayerGroup
3939
:members:

docs/source/layers/popup.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ Example
4040
m
4141

4242

43-
Attributes
44-
----------
43+
Attributes and methods
44+
----------------------
4545

4646
.. autoclass:: ipyleaflet.leaflet.Popup
4747
:members:

docs/source/layers/vector_tile.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,8 +138,8 @@ Example
138138
m
139139

140140

141-
Attributes
142-
----------
141+
Attributes and methods
142+
----------------------
143143

144144
.. autoclass:: ipyleaflet.leaflet.VectorTileLayer
145145
:members:

ipyleaflet/leaflet.py

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1060,7 +1060,7 @@ class LayerGroup(Layer):
10601060
10611061
A group of layers that you can put on the map like other layers.
10621062
1063-
Attributes and methods
1063+
Attributes
10641064
----------
10651065
layers: list, default []
10661066
List of layers to include in the group.
@@ -1144,7 +1144,7 @@ class GeoJSON(FeatureGroup):
11441144
11451145
Layer created from a GeoJSON data structure.
11461146
1147-
Attributes and methods
1147+
Attributes
11481148
----------
11491149
data: dict, default {}
11501150
The JSON data structure.
@@ -1524,20 +1524,16 @@ class MeasureControl(Control):
15241524
15251525
A control which allows making measurements on the Map.
15261526
1527-
Attributes and methods
1528-
----------
1527+
Attributes
1528+
----------------------
15291529
primary_length_unit: str, default 'feet'
1530-
Possible values are 'feet', 'meters', 'miles', 'kilometers' or any user
1531-
defined unit.
1530+
Possible values are 'feet', 'meters', 'miles', 'kilometers' or any user defined unit.
15321531
secondary_length_unit: str, default None
1533-
Possible values are 'feet', 'meters', 'miles', 'kilometers' or any user
1534-
defined unit.
1532+
Possible values are 'feet', 'meters', 'miles', 'kilometers' or any user defined unit.
15351533
primary_area_unit: str, default 'acres'
1536-
Possible values are 'acres', 'hectares', 'sqfeet', 'sqmeters', 'sqmiles'
1537-
or any user defined unit.
1534+
Possible values are 'acres', 'hectares', 'sqfeet', 'sqmeters', 'sqmiles' or any user defined unit.
15381535
secondary_area_unit: str, default None
1539-
Possible values are 'acres', 'hectares', 'sqfeet', 'sqmeters', 'sqmiles'
1540-
or any user defined unit.
1536+
Possible values are 'acres', 'hectares', 'sqfeet', 'sqmeters', 'sqmiles' or any user defined unit.
15411537
active_color: CSS Color, default '#ABE67E'
15421538
The color used for current measurements.
15431539
completed_color: CSS Color, default '#C8F2BE'
@@ -1915,7 +1911,7 @@ def remove_legend_element(self, key):
19151911
class SearchControl(Control):
19161912
""" SearchControl class, with Control as parent class.
19171913
1918-
Attributes and methods
1914+
Attributes
19191915
----------
19201916
19211917
url: string, default ""

0 commit comments

Comments
 (0)