diff --git a/Doc/source/encodings/StandardEncoding.rst b/Doc/source/encodings/StandardEncoding.rst deleted file mode 100644 index 4c936c05c..000000000 --- a/Doc/source/encodings/StandardEncoding.rst +++ /dev/null @@ -1,10 +0,0 @@ -################ -StandardEncoding -################ - -.. automodule:: fontTools.encodings.StandardEncoding - :inherited-members: - :members: - :undoc-members: - -.. data:: fontTools.encodings.StandardEncoding.StandardEncoding diff --git a/Doc/source/encodings/codecs.rst b/Doc/source/encodings/codecs.rst deleted file mode 100644 index ea0b03e9a..000000000 --- a/Doc/source/encodings/codecs.rst +++ /dev/null @@ -1,8 +0,0 @@ -###### -codecs -###### - -.. automodule:: fontTools.encodings.codecs - :inherited-members: - :members: - :undoc-members: diff --git a/Doc/source/encodings/index.rst b/Doc/source/encodings/index.rst index 6de20f4f7..32d13c70e 100644 --- a/Doc/source/encodings/index.rst +++ b/Doc/source/encodings/index.rst @@ -1,17 +1,21 @@ -######### -encodings -######### +################################################## +encodings: Support for OpenType-specific encodings +################################################## -.. toctree:: - :maxdepth: 1 +fontTools includes support for some character encodings found in legacy Mac +TrueType fonts. Many of these legacy encodings have found their way into the +standard Python ``encodings`` library, but others still remain unimplemented. +Importing ``fontTools.encodings.codecs`` will therefore add string ``encode`` +and ``decode`` support for the following encodings: - codecs - macRoman - StandardEncoding +* ``x_mac_japanese_ttx`` +* ``x_mac_trad_chinese_ttx`` +* ``x_mac_korean_ttx`` +* ``x_mac_simp_chinese_ttx`` +fontTools also includes a package (``fontTools.encodings.MacRoman``) which +contains a mapping of glyph IDs to glyph names in the MacRoman character set:: -.. automodule:: fontTools.encodings - :inherited-members: - :members: - :undoc-members: - + >>> from fontTools.encodings.MacRoman import MacRoman + >>> MacRoman[26] + 'twosuperior' diff --git a/Doc/source/encodings/macRoman.rst b/Doc/source/encodings/macRoman.rst deleted file mode 100644 index b56d5e754..000000000 --- a/Doc/source/encodings/macRoman.rst +++ /dev/null @@ -1,10 +0,0 @@ -######## -MacRoman -######## - -.. automodule:: fontTools.encodings.MacRoman - :inherited-members: - :members: - :undoc-members: - -.. data:: fontTools.encodings.MacRoman.MacRoman