Skip to content

Commit 7677d64

Browse files
committed
Documentation improvements
Fix more warnings from sphinx and change the output order to bysource * docs/Geometry.rst - Remove backticks where not allowed * docs/conf.py - Change output order to bysource from default
1 parent 2deb49d commit 7677d64

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

docs/Geometry.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -196,24 +196,24 @@ index to the larger index will walk clockwise around the polygon.
196196

197197
.. attribute:: Polygon2.points
198198

199-
The ordered list of `Vector2`s in this polygon.
199+
The ordered list of Vector2s in this polygon.
200200

201201
.. attribute:: Polygon2.lines
202202

203-
The ordered list of `Line2`s in this polygon.
203+
The ordered list of Line2s in this polygon.
204204

205205
.. attribute:: Polygon2.normals
206206

207-
The orders list of normal `Vector2`s corresponding to the `Line2`'s
207+
The orders list of normal Vector2s corresponding to the Line2s
208208
in lines
209209

210210
.. attribute:: Polygon2.center
211211

212-
The `Vector2` center of the polygon. Lazily initialized.
212+
The Vector2 center of the polygon. Lazily initialized.
213213

214214
.. attribute:: Polygon2.aabb
215215

216-
The `Rect2` bounding box of this polygon. Lazily initialized.
216+
The Rect2 bounding box of this polygon. Lazily initialized.
217217

218218
.. method:: Polygon2(self, points)
219219

docs/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@
4242
u'Omkar Pathak', 'manual'),
4343
]
4444

45+
# Auto-Doc options
46+
autodoc_member_order = 'bysource' # alternatively 'alphabetical' (default) or 'groupwise'
4547

4648
# -- Options for manual page output --------------------------------------------
4749

0 commit comments

Comments
 (0)