Add documentation for 2.1.0 Font changes (celiagg#87)

suarezvictor · Mar 5, 2021 · dff5829 · dff5829
1 parent b41ec08
commit dff5829
Showing 1 changed file with 30 additions and 3 deletions.
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -50,14 +50,24 @@ be used to measure the width of a rendered string.
 .. autoclass:: FontCache
    :members:
 
-.. autoclass:: Font
-   :members:
-
 .. autoclass:: Rect
 
 .. autoclass:: Transform
    :members:
 
+Fonts
+~~~~~
+There are two classes for representing fonts, because celiagg uses the system's
+built-on font selection mechanism on Windows. The correct class for the system
+is selected at runtime and available as the :class:`Font` class. One should be
+aware of this when building software that runs on multiple OSes.
+
+.. autoclass:: FreeTypeFont
+   :members:
+
+.. autoclass:: Win32Font
+   :members:
+
 
 Paint Classes
 -------------
@@ -147,6 +157,23 @@ fill variations use the even-odd rule when filling self-intersecting curves.
   * ``DrawFillStroke``
   * ``DrawEofFillStroke``
 
+FontWeight
+~~~~~~~~~~
+
+When using the :class:`Win32Font` version of :class:`Font`, this enumeration is
+used to select the desired font weight.
+
+  * ``Any``
+  * ``Thin``
+  * ``ExtraLight``
+  * ``Light``
+  * ``Regular``
+  * ``Medium``
+  * ``SemiBold``
+  * ``Bold``
+  * ``ExtraBold``
+  * ``Heavy``
+
 GradientSpread
 ~~~~~~~~~~~~~~