From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Wed, 4 May 2022 23:29:32 +0000 (+0100)
Subject: docs: Fix formatting of sub-entries in gamespec
X-Git-Tag: otter-1.1.0~265
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=commitdiff_plain;h=c0d0538f26eb29298219e318100767969966d3fe;p=otter.git

docs: Fix formatting of sub-entries in gamespec

Re-using the same bullet point symbol confuses Sphinx.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
---

diff --git a/docs/gamespec.rst b/docs/gamespec.rst
index 1a8e3bef..6ecbe7e4 100644
--- a/docs/gamespec.rst
+++ b/docs/gamespec.rst
@@ -133,14 +133,16 @@ This is discussed in the descriptions for each piece spec type.
 
  * ``label``.  Controls display of the label with information about
    the in-game state.  Dictionary with two sub-entries:
-    * ``colour`` [string, defaults to the edge colour].
-    * ``place`` [string]: One of ``"BottomLeft"`` (default),
+
+    - ``colour`` [string, defaults to the edge colour].
+    - ``place`` [string]: One of ``"BottomLeft"`` (default),
       ``"TopLeft"``, ``"BottomLeftOutside"``, ``"TopLeftOutside"``.
 
  * ``shape``.  The shape of a piece.  Dictionary with two sub-entries:
-    * ``type``.  ``"Circle"`` or ``"Rect"`` [required]
-    * ``size`` [array of 1 or 2 numbers]: required if ``type="Rect"``.
-    * ``diam`` [number]: required if ``type="Circle"``.
+
+    - ``type``.  ``"Circle"`` or ``"Rect"`` [required]
+    - ``size`` [array of 1 or 2 numbers]: required if ``type="Rect"``.
+    - ``diam`` [number]: required if ``type="Circle"``.
 
  * ``itemname``: Used when other parts of the game want to refer to
    this one.  [string]