shadowfacts/fonttools
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: pens - add preliminary intro section.

Browse Source
This commit is contained in:
Nathan Williis 2024-09-17 17:24:45 +01:00
parent 69cecfaa10
commit 909da9680b
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
Doc/source/pens/index.rst
View File

@ -2,6 +2,26 @@
pens: Inspect and manipulate glyph outlines
###########################################
.. rubric:: Overview:
:heading-level: 3
The fontTools **pens** are a collection of classes that can operate
on a font glyph via the points and the contours of the glyph's outlines.
Some pens trace through the outlines and generate graphical output,
such as a new glyph outline or a formatted image, but other
pens analyze the outlines and return information about the glyph.
Pens that alter or produce a pen-compatile ``ttGlyph`` object can
be chained together.
New pens can be written by subclassing the ``AbstractPen`` or,
somewhat more practically, ``BasePen`` classes. The Pen Protocol is
documented on the ``BasePen`` page.
.. rubric:: Pens:
:heading-level: 3
.. toctree::
:maxdepth: 1