Documentation for ev3dev.fonts module

Author: ddemidov

docs/_static/fonts.png

@@ -96,6 +96,29 @@ Screen
     :members:
     :show-inheritance:
 
+Bitmap fonts
+^^^^^^^^^^^^
+
+The :py:class:`Screen` class allows to write text on the LCD using python
+imaging library (PIL) interface (see description of the ``text()`` method
+`here <http://pillow.readthedocs.io/en/3.1.x/reference/ImageDraw.html#PIL.ImageDraw.PIL.ImageDraw.Draw.text>`_).
+The ``ev3dev.fonts`` module contains bitmap fonts in PIL format that should
+look good on a tiny EV3 screen:
+
+.. code-block:: py
+
+    import ev3dev.fonts as fonts
+    screen.draw.text((10,10), 'Hello World!', font=fonts.load('luBS14'))
+
+.. autofunction:: ev3dev.fonts.available
+
+.. autofunction:: ev3dev.fonts.load
+
+The following image lists all available fonts. The grid lines correspond
+to EV3 screen size:
+
+.. image:: _static/fonts.png
+
 Lego Port
 ---------
 

docs/other.rst

@@ -2,7 +2,10 @@
 import os.path
 from PIL import ImageFont
 
-def list():
+def available():
+    """
+    Returns list of available font names.
+    """
     names = []
     for f in pkg_resources.resource_listdir('ev3dev.fonts', ''):
         name, ext = os.path.splitext(os.path.basename(f))
@@ -11,6 +14,11 @@ def list():
     return sorted(names)
 
 def load(name):
+    """
+    Loads the font specified by name and returns it as an instance of
+    `PIL.ImageFont <http://pillow.readthedocs.io/en/latest/reference/ImageFont.html>`_
+    class.
+    """
     pil_file = pkg_resources.resource_filename('ev3dev.fonts', '{}.pil'.format(name))
     pbm_file = pkg_resources.resource_filename('ev3dev.fonts', '{}.pbm'.format(name))
     return ImageFont.load(pil_file)