Skip to content

Commit

Permalink
Exclude font definitions from autodoc; add docstring table instead (#133
Browse files Browse the repository at this point in the history 
)

Fixes #131
  • Loading branch information
@rm-hull
rm-hull committed Mar 29, 2018
1 parent 19e389a commit 11f67e9
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 1 deletion.
1 change: 1 addition & 0 deletions doc/api-documentation.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ API Documentation
:members:
:undoc-members:
:show-inheritance:
:exclude-members: CP437_FONT, SINCLAIR_FONT, LCD_FONT, UKR_FONT, TINY_FONT,SEG7_FONT

:mod:`luma.core.mixin`
""""""""""""""""""""""
Expand Down
25 changes: 24 additions & 1 deletion luma/core/legacy/font.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,30 @@
# See LICENSE.rst for details.

"""
Fixed-width font definitions
Fixed-width font definitions. The following fonts are available:
+-------------------+-------------------------------------------------+-----------------------------------------------------------------------------------------------+
| Font name | Notes | Source |
+===================+=================================================+===============================================================================================+
| ``CP437_FONT`` | See https://en.wikipedia.org/wiki/Code_page_437 | *unascribed* |
| | for further details. | |
+-------------------+-------------------------------------------------+-----------------------------------------------------------------------------------------------+
| ``LCD_FONT`` | Only contains characters 0x20-0x7F inclusive | http://www.avrfreaks.net/forum/code-57-512-and-712-fonts?name=PNphpBB2&file=viewtopic&t=69880 |
| | and Cyrillic chars 0x80-0xBF (except 'Ёё'); | |
| | all others will appear as blanks. | |
+-------------------+-------------------------------------------------+-----------------------------------------------------------------------------------------------+
| ``SEG7_FONT`` | Only contains characters 0x41-0x5A & 0x30-0x39 | https://www.dafont.com/digital-7.font |
| | inclusive; all others will appear as blanks. | |
+-------------------+-------------------------------------------------+-----------------------------------------------------------------------------------------------+
| ``SINCLAIR_FONT`` | Based on the character set from the Sinclair ZX | http://www.henningkarlsen.com/electronics/r_fonts.php |
| | Spectrum. Only contains characters 0x20-0x7E | |
| | inclusive; all others will appear as blanks. | |
+-------------------+-------------------------------------------------+-----------------------------------------------------------------------------------------------+
| ``TINY_FONT`` | Only contains characters 0x20-0x7E inclusive; | http://www.dafont.com/tiny.font |
| | all others will appear as blanks. | |
+-------------------+-------------------------------------------------+-----------------------------------------------------------------------------------------------+
| ``UKR_FONT`` | Cyrillic Ukrainian font | *unascribed* |
+-------------------+-------------------------------------------------+-----------------------------------------------------------------------------------------------+
"""


Expand Down

0 comments on commit 11f67e9

Please sign in to comment.