setting up Sphinx-based autodocs

This commit is contained in:
Gustavo Ferreira 2017-04-21 19:47:28 -03:00
parent 3f839878eb
commit 9eae1bd2e0
56 changed files with 1212 additions and 225 deletions

20
Doc/Makefile Normal file
View File

@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = fontTools
SOURCEDIR = source
BUILDDIR = build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

36
Doc/make.bat Normal file
View File

@ -0,0 +1,36 @@
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build
set SPHINXPROJ=fontTools
if "%1" == "" goto help
%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
:end
popd

View File

@ -1,225 +0,0 @@
.Dd May 18, 2004
.\" ttx is not specific to any OS, but contrary to what groff_mdoc(7)
.\" seems to imply, entirely omitting the .Os macro causes 'BSD' to
.\" be used, so I give a zero-width space as its argument.
.Os \&
.\" The "FontTools Manual" argument apparently has no effect in
.\" groff 1.18.1. I think it is a bug in the -mdoc groff package.
.Dt TTX 1 "FontTools Manual"
.Sh NAME
.Nm ttx
.Nd tool for manipulating TrueType and OpenType fonts
.Sh SYNOPSIS
.Nm
.Bk
.Op Ar option ...
.Ek
.Bk
.Ar file ...
.Ek
.Sh DESCRIPTION
.Nm
is a tool for manipulating TrueType and OpenType fonts. It can convert
TrueType and OpenType fonts to and from an
.Tn XML Ns -based format called
.Tn TTX .
.Tn TTX
files have a
.Ql .ttx
extension.
.Pp
For each
.Ar file
argument it is given,
.Nm
detects whether it is a
.Ql .ttf ,
.Ql .otf
or
.Ql .ttx
file and acts accordingly: if it is a
.Ql .ttf
or
.Ql .otf
file, it generates a
.Ql .ttx
file; if it is a
.Ql .ttx
file, it generates a
.Ql .ttf
or
.Ql .otf
file.
.Pp
By default, every output file is created in the same directory as the
corresponding input file and with the same name except for the
extension, which is substituted appropriately.
.Nm
never overwrites existing files; if necessary, it appends a suffix to
the output file name before the extension, as in
.Pa Arial#1.ttf .
.Ss "General options"
.Bl -tag -width ".Fl t Ar table"
.It Fl h
Display usage information.
.It Fl d Ar dir
Write the output files to directory
.Ar dir
instead of writing every output file to the same directory as the
corresponding input file.
.It Fl o Ar file
Write the output to
.Ar file
instead of writing it to the same directory as the
corresponding input file.
.It Fl v
Be verbose. Write more messages to the standard output describing what
is being done.
.It Fl a
Allow virtual glyphs ID's on compile or decompile.
.El
.Ss "Dump options"
The following options control the process of dumping font files
(TrueType or OpenType) to
.Tn TTX
files.
.Bl -tag -width ".Fl t Ar table"
.It Fl l
List table information. Instead of dumping the font to a
.Tn TTX
file, display minimal information about each table.
.It Fl t Ar table
Dump table
.Ar table .
This option may be given multiple times to dump several tables at
once. When not specified, all tables are dumped.
.It Fl x Ar table
Exclude table
.Ar table
from the list of tables to dump. This option may be given multiple
times to exclude several tables from the dump. The
.Fl t
and
.Fl x
options are mutually exclusive.
.It Fl s
Split tables. Dump each table to a separate
.Tn TTX
file and write (under the name that would have been used for the output
file if the
.Fl s
option had not been given) one small
.Tn TTX
file containing references to the individual table dump files. This
file can be used as input to
.Nm
as long as the referenced files can be found in the same directory.
.It Fl i
.\" XXX: I suppose OpenType programs (exist and) are also affected.
Don't disassemble TrueType instructions. When this option is specified,
all TrueType programs (glyph programs, the font program and the
pre-program) are written to the
.Tn TTX
file as hexadecimal data instead of
assembly. This saves some time and results in smaller
.Tn TTX
files.
.It Fl y Ar n
When decompiling a TrueType Collection (TTC) file,
decompile font number
.Ar n ,
starting from 0.
.El
.Ss "Compilation options"
The following options control the process of compiling
.Tn TTX
files into font files (TrueType or OpenType):
.Bl -tag -width ".Fl t Ar table"
.It Fl m Ar fontfile
Merge the input
.Tn TTX
file
.Ar file
with
.Ar fontfile .
No more than one
.Ar file
argument can be specified when this option is used.
.It Fl b
Don't recalculate glyph bounding boxes. Use the values in the
.Tn TTX
file as is.
.El
.Sh "THE TTX FILE FORMAT"
You can find some information about the
.Tn TTX
file format in
.Pa documentation.html .
In particular, you will find in that file the list of tables understood by
.Nm
and the relations between TrueType GlyphIDs and the glyph names used in
.Tn TTX
files.
.Sh EXAMPLES
In the following examples, all files are read from and written to the
current directory. Additionally, the name given for the output file
assumes in every case that it did not exist before
.Nm
was invoked.
.Pp
Dump the TrueType font contained in
.Pa FreeSans.ttf
to
.Pa FreeSans.ttx :
.Pp
.Dl ttx FreeSans.ttf
.Pp
Compile
.Pa MyFont.ttx
into a TrueType or OpenType font file:
.Pp
.Dl ttx MyFont.ttx
.Pp
List the tables in
.Pa FreeSans.ttf
along with some information:
.Pp
.Dl ttx -l FreeSans.ttf
.Pp
Dump the
.Sq cmap
table from
.Pa FreeSans.ttf
to
.Pa FreeSans.ttx :
.Pp
.Dl ttx -t cmap FreeSans.ttf
.Sh NOTES
On MS\-Windows and MacOS,
.Nm
is available as a graphical application to which files can be dropped.
.Sh SEE ALSO
.Pa documentation.html
.Pp
.Xr fontforge 1 ,
.Xr ftinfo 1 ,
.Xr gfontview 1 ,
.Xr xmbdfed 1 ,
.Xr Font::TTF 3pm
.Sh AUTHORS
.Nm
was written by
.An -nosplit
.An "Just van Rossum" Aq just@letterror.com .
.Pp
This manual page was written by
.An "Florent Rougon" Aq f.rougon@free.fr
for the Debian GNU/Linux system based on the existing FontTools
documentation. It may be freely used, modified and distributed without
restrictions.
.\" For Emacs:
.\" Local Variables:
.\" fill-column: 72
.\" sentence-end: "[.?!][]\"')}]*\\($\\| $\\| \\| \\)[ \n]*"
.\" sentence-end-double-space: t
.\" End:

7
Doc/source/afmLib.rst Normal file
View File

@ -0,0 +1,7 @@
######
afmLib
######
.. automodule:: fontTools.afmLib
:members:
:undoc-members:

7
Doc/source/agl.rst Normal file
View File

@ -0,0 +1,7 @@
###
agl
###
.. automodule:: fontTools.agl
:members:
:undoc-members:

7
Doc/source/cffLib.rst Normal file
View File

@ -0,0 +1,7 @@
######
cffLib
######
.. automodule:: fontTools.cffLib
:members:
:undoc-members:

156
Doc/source/conf.py Normal file
View File

@ -0,0 +1,156 @@
# -*- coding: utf-8 -*-
#
# fontTools documentation build configuration file, created by
# sphinx-quickstart on Thu Apr 20 11:07:39 2017.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
needs_sphinx = '1.3'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
autodoc_mock_imports = ['gtk']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'fontTools'
copyright = u'2017, Just van Rossum, Behdad Esfahbod et al.'
author = u'Just van Rossum, Behdad Esfahbod et al.'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = u'3.10'
# The full version, including alpha/beta/rc tags.
release = u'3.10'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = []
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'classic'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# -- Options for HTMLHelp output ------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'fontToolsDoc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'fontTools.tex', u'fontTools Documentation',
u'Just van Rossum, Behdad Esfahbod et al.', 'manual'),
]
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'fonttools', u'fontTools Documentation',
[author], 1)
]
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'fontTools', u'fontTools Documentation',
author, 'fontTools', 'A library for manipulating fonts, written in Python.',
'Typography'),
]

14
Doc/source/encodings.rst Normal file
View File

@ -0,0 +1,14 @@
#########
encodings
#########
.. automodule:: fontTools.encodings
:members:
:undoc-members:
codecs
------
.. automodule:: fontTools.encodings.codecs
:members:
:undoc-members:

43
Doc/source/feaLib.rst Normal file
View File

@ -0,0 +1,43 @@
######
feaLib
######
.. automodule:: fontTools.feaLib
:members:
:undoc-members:
ast
---
.. automodule:: fontTools.feaLib.ast
:members:
:undoc-members:
builder
-------
.. automodule:: fontTools.feaLib.builder
:members:
:undoc-members:
error
-----
.. automodule:: fontTools.feaLib.parser
:members:
:undoc-members:
lexer
-----
.. automodule:: fontTools.feaLib.lexer
:members:
:undoc-members:
parser
------
.. automodule:: fontTools.feaLib.parser
:members:
:undoc-members:

28
Doc/source/index.rst Normal file
View File

@ -0,0 +1,28 @@
fontTools Docs
==============
.. toctree::
:maxdepth: 1
afmLib
agl
cffLib
inspect
encodings
feaLib
merge
misc/index
pens/index
subset
t1Lib
ttLib/index
ttx
varLib/index
voltLib
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

7
Doc/source/inspect.rst Normal file
View File

@ -0,0 +1,7 @@
#######
inspect
#######
.. automodule:: fontTools.inspect
:members:
:undoc-members:

7
Doc/source/merge.rst Normal file
View File

@ -0,0 +1,7 @@
#####
merge
#####
.. automodule:: fontTools.merge
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
##########
arrayTools
##########
.. automodule:: fontTools.misc.arrayTools
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
###########
bezierTools
###########
.. automodule:: fontTools.misc.bezierTools
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
#############
classifyTools
#############
.. automodule:: fontTools.misc.classifyTools
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
#####
eexec
#####
.. automodule:: fontTools.misc.eexec
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
#############
encodingTools
#############
.. automodule:: fontTools.misc.encodingTools
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
##########
fixedTools
##########
.. automodule:: fontTools.misc.fixedTools
:members:
:undoc-members:

23
Doc/source/misc/index.rst Normal file
View File

@ -0,0 +1,23 @@
####
misc
####
.. toctree::
:maxdepth: 2
arrayTools
bezierTools
classifyTools
eexec
encodingTools
fixedTools
loggingTools
sstruct
psCharStrings
testTools
textTools
timeTools
transform
xmlReader
xmlWriter

View File

@ -0,0 +1,7 @@
############
loggingTools
############
.. automodule:: fontTools.misc.loggingTools
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
#############
psCharStrings
#############
.. automodule:: fontTools.misc.psCharStrings
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
#######
sstruct
#######
.. automodule:: fontTools.misc.sstruct
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
#########
testTools
#########
.. automodule:: fontTools.misc.testTools
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
#########
textTools
#########
.. automodule:: fontTools.misc.textTools
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
#########
timeTools
#########
.. automodule:: fontTools.misc.timeTools
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
#########
transform
#########
.. automodule:: fontTools.misc.transform
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
#########
xmlReader
#########
.. automodule:: fontTools.misc.xmlReader
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
#########
xmlWriter
#########
.. automodule:: fontTools.misc.xmlWriter
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
#######
areaPen
#######
.. automodule:: fontTools.pens.areaPen
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
#######
basePen
#######
.. automodule:: fontTools.pens.basePen
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
#########
boundsPen
#########
.. automodule:: fontTools.pens.boundsPen
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
#########
filterPen
#########
.. automodule:: fontTools.pens.filterPen
:members:
:undoc-members:

18
Doc/source/pens/index.rst Normal file
View File

@ -0,0 +1,18 @@
####
pens
####
.. toctree::
:maxdepth: 1
basePen
boundsPen
pointInsidePen
filterPen
transformPen
t2CharStringPen
statisticsPen
recordingPen
teePen
areaPen
perimeterPen

View File

@ -0,0 +1,7 @@
############
perimeterPen
############
.. automodule:: fontTools.pens.perimeterPen
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
##############
pointInsidePen
##############
.. automodule:: fontTools.pens.pointInsidePen
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
############
recordingPen
############
.. automodule:: fontTools.pens.recordingPen
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
#############
statisticsPen
#############
.. automodule:: fontTools.pens.statisticsPen
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
###############
t2CharStringPen
###############
.. automodule:: fontTools.pens.t2CharStringPen
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
######
teePen
######
.. automodule:: fontTools.pens.teePen
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
############
transformPen
############
.. automodule:: fontTools.pens.transformPen
:members:
:undoc-members:

7
Doc/source/subset.rst Normal file
View File

@ -0,0 +1,7 @@
######
subset
######
.. automodule:: fontTools.subset
:members:
:undoc-members:

7
Doc/source/t1Lib.rst Normal file
View File

@ -0,0 +1,7 @@
#####
t1Lib
#####
.. automodule:: fontTools.t1Lib
:members:
:undoc-members:

View File

@ -0,0 +1,15 @@
#####
ttLib
#####
.. toctree::
:maxdepth: 1
macUtils
sfnt
tables
woff2
.. automodule:: fontTools.ttLib
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
########
macUtils
########
.. automodule:: fontTools.ttLib.macUtils
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
####
sfnt
####
.. automodule:: fontTools.ttLib.sfnt
:members:
:undoc-members:

506
Doc/source/ttLib/tables.rst Normal file
View File

@ -0,0 +1,506 @@
######
tables
######
.. automodule:: fontTools.ttLib.tables
:members:
:undoc-members:
_a_v_a_r
--------
.. automodule:: fontTools.ttLib.tables._a_v_a_r
:members:
:undoc-members:
_c_m_a_p
--------
.. automodule:: fontTools.ttLib.tables._c_m_a_p
:members:
:undoc-members:
_c_v_a_r
--------
.. automodule:: fontTools.ttLib.tables._c_v_a_r
:members:
:undoc-members:
_c_v_t
------
.. automodule:: fontTools.ttLib.tables._c_v_t
:members:
:undoc-members:
_f_e_a_t
--------
.. automodule:: fontTools.ttLib.tables._f_e_a_t
:members:
:undoc-members:
_f_p_g_m
--------
.. automodule:: fontTools.ttLib.tables._f_p_g_m
:members:
:undoc-members:
_f_v_a_r
--------
.. automodule:: fontTools.ttLib.tables._f_v_a_r
:members:
:undoc-members:
_g_a_s_p
--------
.. automodule:: fontTools.ttLib.tables._g_a_s_p
:members:
:undoc-members:
_g_l_y_f
--------
.. automodule:: fontTools.ttLib.tables._g_l_y_f
:members:
:undoc-members:
_g_v_a_r
--------
.. automodule:: fontTools.ttLib.tables._g_v_a_r
:members:
:undoc-members:
_h_d_m_x
--------
.. automodule:: fontTools.ttLib.tables._h_d_m_x
:members:
:undoc-members:
_h_e_a_d
--------
.. automodule:: fontTools.ttLib.tables._h_e_a_d
:members:
:undoc-members:
_h_h_e_a
--------
.. automodule:: fontTools.ttLib.tables._h_h_e_a
:members:
:undoc-members:
_h_m_t_x
--------
.. automodule:: fontTools.ttLib.tables._h_m_t_x
:members:
:undoc-members:
_k_e_r_n
--------
.. automodule:: fontTools.ttLib.tables._k_e_r_n
:members:
:undoc-members:
_l_o_c_a
--------
.. automodule:: fontTools.ttLib.tables._l_o_c_a
:members:
:undoc-members:
_l_t_a_g
--------
.. automodule:: fontTools.ttLib.tables._l_t_a_g
:members:
:undoc-members:
_m_a_x_p
--------
.. automodule:: fontTools.ttLib.tables._m_a_x_p
:members:
:undoc-members:
_m_e_t_a
--------
.. automodule:: fontTools.ttLib.tables._m_e_t_a
:members:
:undoc-members:
_n_a_m_e
--------
.. automodule:: fontTools.ttLib.tables._n_a_m_e
:members:
:undoc-members:
_p_o_s_t
--------
.. automodule:: fontTools.ttLib.tables._p_o_s_t
:members:
:undoc-members:
_p_r_e_p
--------
.. automodule:: fontTools.ttLib.tables._p_r_e_p
:members:
:undoc-members:
_s_b_i_x
--------
.. automodule:: fontTools.ttLib.tables._s_b_i_x
:members:
:undoc-members:
_t_r_a_k
--------
.. automodule:: fontTools.ttLib.tables._t_r_a_k
:members:
:undoc-members:
_v_h_e_a
--------
.. automodule:: fontTools.ttLib.tables._v_h_e_a
:members:
:undoc-members:
_v_m_t_x
--------
.. automodule:: fontTools.ttLib.tables._v_m_t_x
:members:
:undoc-members:
asciiTable
----------
.. automodule:: fontTools.ttLib.tables.asciiTable
:members:
:undoc-members:
B_A_S_E_
--------
.. automodule:: fontTools.ttLib.tables.B_A_S_E_
:members:
:undoc-members:
BitmapGlyphMetrics
------------------
.. automodule:: fontTools.ttLib.tables.BitmapGlyphMetrics
:members:
:undoc-members:
C_B_D_T_
--------
.. automodule:: fontTools.ttLib.tables.C_B_D_T_
:members:
:undoc-members:
C_B_L_C_
--------
.. automodule:: fontTools.ttLib.tables.C_B_L_C_
:members:
:undoc-members:
C_F_F_
------
.. automodule:: fontTools.ttLib.tables.C_F_F_
:members:
:undoc-members:
C_F_F__2
--------
.. automodule:: fontTools.ttLib.tables.C_F_F__2
:members:
:undoc-members:
C_O_L_R_
--------
.. automodule:: fontTools.ttLib.tables.C_O_L_R_
:members:
:undoc-members:
C_P_A_L_
--------
.. automodule:: fontTools.ttLib.tables.C_P_A_L_
:members:
:undoc-members:
D_S_I_G_
--------
.. automodule:: fontTools.ttLib.tables.D_S_I_G_
:members:
:undoc-members:
DefaultTable
------------
.. automodule:: fontTools.ttLib.tables.DefaultTable
:members:
:undoc-members:
E_B_D_T_
--------
.. automodule:: fontTools.ttLib.tables.E_B_D_T_
:members:
:undoc-members:
E_B_L_C_
--------
.. automodule:: fontTools.ttLib.tables.E_B_L_C_
:members:
:undoc-members:
F_F_T_M_
--------
.. automodule:: fontTools.ttLib.tables.F_F_T_M_
:members:
:undoc-members:
G_D_E_F_
--------
.. automodule:: fontTools.ttLib.tables.G_D_E_F_
:members:
:undoc-members:
G_M_A_P_
--------
.. automodule:: fontTools.ttLib.tables.G_M_A_P_
:members:
:undoc-members:
G_P_K_G_
--------
.. automodule:: fontTools.ttLib.tables.G_P_K_G_
:members:
:undoc-members:
G_P_O_S_
--------
.. automodule:: fontTools.ttLib.tables.G_P_O_S_
:members:
:undoc-members:
G_S_U_B_
--------
.. automodule:: fontTools.ttLib.tables.G_S_U_B_
:members:
:undoc-members:
H_V_A_R_
--------
.. automodule:: fontTools.ttLib.tables.H_V_A_R_
:members:
:undoc-members:
J_S_T_F_
--------
.. automodule:: fontTools.ttLib.tables.J_S_T_F_
:members:
:undoc-members:
L_T_S_H_
--------
.. automodule:: fontTools.ttLib.tables.L_T_S_H_
:members:
:undoc-members:
M_A_T_H_
--------
.. automodule:: fontTools.ttLib.tables.M_A_T_H_
:members:
:undoc-members:
M_E_T_A_
--------
.. automodule:: fontTools.ttLib.tables.M_E_T_A_
:members:
:undoc-members:
M_V_A_R_
--------
.. automodule:: fontTools.ttLib.tables.M_V_A_R_
:members:
:undoc-members:
O_S_2f_2
--------
.. automodule:: fontTools.ttLib.tables.O_S_2f_2
:members:
:undoc-members:
otBase
------
.. automodule:: fontTools.ttLib.tables.otBase
:members:
:undoc-members:
otConverters
------------
.. automodule:: fontTools.ttLib.tables.otConverters
:members:
:undoc-members:
otData
------
.. automodule:: fontTools.ttLib.tables.otData
:members:
:undoc-members:
otTables
--------
.. automodule:: fontTools.ttLib.tables.otTables
:members:
:undoc-members:
S_I_N_G_
--------
.. automodule:: fontTools.ttLib.tables.S_I_N_G_
:members:
:undoc-members:
S_T_A_T_
--------
.. automodule:: fontTools.ttLib.tables.S_T_A_T_
:members:
:undoc-members:
S_V_G_
------
.. automodule:: fontTools.ttLib.tables.S_V_G_
:members:
:undoc-members:
sbixGlyph
---------
.. automodule:: fontTools.ttLib.tables.sbixGlyph
:members:
:undoc-members:
sbixStrike
----------
.. automodule:: fontTools.ttLib.tables.sbixStrike
:members:
:undoc-members:
T_S_I__0
--------
.. automodule:: fontTools.ttLib.tables.T_S_I__0
:members:
:undoc-members:
T_S_I__1
--------
.. automodule:: fontTools.ttLib.tables.T_S_I__1
:members:
:undoc-members:
T_S_I__2
--------
.. automodule:: fontTools.ttLib.tables.T_S_I__2
:members:
:undoc-members:
T_S_I__3
--------
.. automodule:: fontTools.ttLib.tables.T_S_I__3
:members:
:undoc-members:
T_S_I__5
--------
.. automodule:: fontTools.ttLib.tables.T_S_I__5
:members:
:undoc-members:
ttProgram
---------
.. automodule:: fontTools.ttLib.tables.ttProgram
:members:
:undoc-members:
TupleVariation
--------------
.. automodule:: fontTools.ttLib.tables.TupleVariation
:members:
:undoc-members:
V_D_M_X_
--------
.. automodule:: fontTools.ttLib.tables.V_D_M_X_
:members:
:undoc-members:
V_O_R_G_
--------
.. automodule:: fontTools.ttLib.tables.V_O_R_G_
:members:
:undoc-members:
V_V_A_R_
--------
.. automodule:: fontTools.ttLib.tables.V_V_A_R_
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
#####
woff2
#####
.. automodule:: fontTools.ttLib.woff2
:members:
:undoc-members:

7
Doc/source/ttx.rst Normal file
View File

@ -0,0 +1,7 @@
###
ttx
###
.. automodule:: fontTools.ttx
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
###########
designspace
###########
.. automodule:: fontTools.varLib.designspace
:members:
:undoc-members:

View File

@ -0,0 +1,17 @@
######
varLib
######
.. toctree::
:maxdepth: 2
designspace
interpolatable
interpolate_layout
merger
models
mutator
.. automodule:: fontTools.varLib
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
##############
interpolatable
##############
.. automodule:: fontTools.varLib.interpolatable
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
##################
interpolate_layout
##################
.. automodule:: fontTools.varLib.interpolate_layout
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
######
merger
######
.. automodule:: fontTools.varLib.merger
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
######
models
######
.. automodule:: fontTools.varLib.models
:members:
:undoc-members:

View File

@ -0,0 +1,7 @@
#######
mutator
#######
.. automodule:: fontTools.varLib.mutator
:members:
:undoc-members:

35
Doc/source/voltLib.rst Normal file
View File

@ -0,0 +1,35 @@
#######
voltLib
#######
.. automodule:: fontTools.voltLib
:members:
:undoc-members:
ast
---
.. automodule:: fontTools.voltLib.ast
:members:
:undoc-members:
error
-----
.. automodule:: fontTools.voltLib.parser
:members:
:undoc-members:
lexer
-----
.. automodule:: fontTools.voltLib.lexer
:members:
:undoc-members:
parser
------
.. automodule:: fontTools.voltLib.parser
:members:
:undoc-members: