Skip to content

Commit

Permalink
Merge pull request #1891 from chrissimpkins/docs-fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
chrissimpkins committed Apr 22, 2020
2 parents 493581a + 414c66f commit 84df2c4
Showing 1 changed file with 22 additions and 26 deletions.
48 changes: 22 additions & 26 deletions Doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,9 @@ For example:
This command will install fonttools, as well as the optional dependencies that
are required to unlock the extra features named "ufo", etc.

Optional dependencies are detailed by module in the list below.
.. note::

Optional dependencies are detailed by module in the list below with the ``Extra`` setting that automates ``pip`` dependency installation when this is supported.



Expand All @@ -169,11 +171,9 @@ The module exports a ElementTree-like API for reading/writing XML files, and all

Package for reading and writing UFO source files; it requires:

* `fs <https://pypi.org/pypi/fs>`__: (aka ``pyfilesystem2``) filesystem
abstraction layer.
* `fs <https://pypi.org/pypi/fs>`__: (aka ``pyfilesystem2``) filesystem abstraction layer.

* `enum34 <https://pypi.org/pypi/enum34>`__: backport for the built-in ``enum``
module (only required on Python < 3.4).
* `enum34 <https://pypi.org/pypi/enum34>`__: backport for the built-in ``enum`` module (only required on Python < 3.4).

*Extra:* ``ufo``

Expand All @@ -183,8 +183,7 @@ module (only required on Python < 3.4).

Module to compress/decompress WOFF 2.0 web fonts; it requires:

* `brotli <https://pypi.python.org/pypi/Brotli>`__: Python bindings of
the Brotli compression library.
* `brotli <https://pypi.python.org/pypi/Brotli>`__: Python bindings of the Brotli compression library.

*Extra:* ``woff``

Expand All @@ -197,10 +196,9 @@ with ``ttx`` we use the ``unicodedata`` module in the Standard Library.
The version included in there varies between different Python versions.
To use the latest available data, you can install:

* `unicodedata2 <https://pypi.python.org/pypi/unicodedata2>`__:
``unicodedata`` backport for Python 2.7 and 3.x updated to the latest
Unicode version 12.0. Note this is not necessary if you use Python 3.8
as the latter already comes with an up-to-date ``unicodedata``.
* `unicodedata2 <https://pypi.python.org/pypi/unicodedata2>`__: ``unicodedata`` backport for Python 2.7
and 3.x updated to the latest Unicode version 12.0. Note this is not necessary if you use Python 3.8
as the latter already comes with an up-to-date ``unicodedata``.

*Extra:* ``unicode``

Expand All @@ -213,11 +211,10 @@ It requires one of the following packages in order to solve the so-called
"minimum weight perfect matching problem in bipartite graphs", or
the Assignment problem:

* `scipy <https://pypi.python.org/pypi/scipy>`__: the Scientific Library
for Python, which internally uses `NumPy <https://pypi.python.org/pypi/numpy>`__
arrays and hence is very fast;
* `munkres <https://pypi.python.org/pypi/munkres>`__: a pure-Python
module that implements the Hungarian or Kuhn-Munkres algorithm.
* `scipy <https://pypi.python.org/pypi/scipy>`__: the Scientific Library for Python, which internally
uses `NumPy <https://pypi.python.org/pypi/numpy>`__ arrays and hence is very fast;
* `munkres <https://pypi.python.org/pypi/munkres>`__: a pure-Python module that implements the Hungarian
or Kuhn-Munkres algorithm.

*Extra:* ``interpolatable``

Expand All @@ -237,8 +234,7 @@ Module for visualizing DesignSpaceDocument and resulting VariationModel.

Advanced module for symbolic font statistics analysis; it requires:

* `sympy <https://pypi.python.org/pypi/sympy>`__: the Python library for
symbolic mathematics.
* `sympy <https://pypi.python.org/pypi/sympy>`__: the Python library for symbolic mathematics.

*Extra:* ``symfont``

Expand All @@ -250,8 +246,8 @@ To get the file creator and type of Macintosh PostScript Type 1 fonts
on Python 3 you need to install the following module, as the old ``MacOS``
module is no longer included in Mac Python:

* `xattr <https://pypi.python.org/pypi/xattr>`__: Python wrapper for
extended filesystem attributes (macOS platform only).
* `xattr <https://pypi.python.org/pypi/xattr>`__: Python wrapper for extended filesystem attributes
(macOS platform only).

*Extra:* ``type1``

Expand All @@ -261,26 +257,26 @@ extended filesystem attributes (macOS platform only).

Pen for drawing glyphs with Cocoa ``NSBezierPath``, requires:

* `PyObjC <https://pypi.python.org/pypi/pyobjc>`__: the bridge between
Python and the Objective-C runtime (macOS platform only).
* `PyObjC <https://pypi.python.org/pypi/pyobjc>`__: the bridge between Python and the Objective-C
runtime (macOS platform only).


:py:mod:`fontTools.pens.qtPen`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Pen for drawing glyphs with Qt's ``QPainterPath``, requires:

* `PyQt5 <https://pypi.python.org/pypi/PyQt5>`__: Python bindings for
the Qt cross platform UI and application toolkit.
* `PyQt5 <https://pypi.python.org/pypi/PyQt5>`__: Python bindings for the Qt cross platform UI and
application toolkit.


:py:mod:`fontTools.pens.reportLabPen`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Pen to drawing glyphs as PNG images, requires:

* `reportlab <https://pypi.python.org/pypi/reportlab>`__: Python toolkit
for generating PDFs and graphics.
* `reportlab <https://pypi.python.org/pypi/reportlab>`__: Python toolkit for generating PDFs and
graphics.


Testing
Expand Down

0 comments on commit 84df2c4

Please sign in to comment.