From 9eae1bd2e073130ff7323b2b01b67b37e46fc394 Mon Sep 17 00:00:00 2001 From: Gustavo Ferreira Date: Fri, 21 Apr 2017 19:47:28 -0300 Subject: [PATCH 1/2] setting up Sphinx-based autodocs --- Doc/Makefile | 20 + Doc/make.bat | 36 ++ Doc/man/man1/ttx.1 | 225 ---------- Doc/source/afmLib.rst | 7 + Doc/source/agl.rst | 7 + Doc/source/cffLib.rst | 7 + Doc/source/conf.py | 156 +++++++ Doc/source/encodings.rst | 14 + Doc/source/feaLib.rst | 43 ++ Doc/source/index.rst | 28 ++ Doc/source/inspect.rst | 7 + Doc/source/merge.rst | 7 + Doc/source/misc/arrayTools.rst | 7 + Doc/source/misc/bezierTools.rst | 7 + Doc/source/misc/classifyTools.rst | 7 + Doc/source/misc/eexec.rst | 7 + Doc/source/misc/encodingTools.rst | 7 + Doc/source/misc/fixedTools.rst | 7 + Doc/source/misc/index.rst | 23 ++ Doc/source/misc/loggingTools.rst | 7 + Doc/source/misc/psCharStrings.rst | 7 + Doc/source/misc/sstruct.rst | 7 + Doc/source/misc/testTools.rst | 7 + Doc/source/misc/textTools.rst | 7 + Doc/source/misc/timeTools.rst | 7 + Doc/source/misc/transform.rst | 7 + Doc/source/misc/xmlReader.rst | 7 + Doc/source/misc/xmlWriter.rst | 7 + Doc/source/pens/areaPen.rst | 7 + Doc/source/pens/basePen.rst | 7 + Doc/source/pens/boundsPen.rst | 7 + Doc/source/pens/filterPen.rst | 7 + Doc/source/pens/index.rst | 18 + Doc/source/pens/perimeterPen.rst | 7 + Doc/source/pens/pointInsidePen.rst | 7 + Doc/source/pens/recordingPen.rst | 7 + Doc/source/pens/statisticsPen.rst | 7 + Doc/source/pens/t2CharStringPen.rst | 7 + Doc/source/pens/teePen.rst | 7 + Doc/source/pens/transformPen.rst | 7 + Doc/source/subset.rst | 7 + Doc/source/t1Lib.rst | 7 + Doc/source/ttLib/index.rst | 15 + Doc/source/ttLib/macUtils.rst | 7 + Doc/source/ttLib/sfnt.rst | 7 + Doc/source/ttLib/tables.rst | 506 +++++++++++++++++++++++ Doc/source/ttLib/woff2.rst | 7 + Doc/source/ttx.rst | 7 + Doc/source/varLib/designspace.rst | 7 + Doc/source/varLib/index.rst | 17 + Doc/source/varLib/interpolatable.rst | 7 + Doc/source/varLib/interpolate_layout.rst | 7 + Doc/source/varLib/merger.rst | 7 + Doc/source/varLib/models.rst | 7 + Doc/source/varLib/mutator.rst | 7 + Doc/source/voltLib.rst | 35 ++ 56 files changed, 1212 insertions(+), 225 deletions(-) create mode 100644 Doc/Makefile create mode 100644 Doc/make.bat delete mode 100644 Doc/man/man1/ttx.1 create mode 100644 Doc/source/afmLib.rst create mode 100644 Doc/source/agl.rst create mode 100644 Doc/source/cffLib.rst create mode 100644 Doc/source/conf.py create mode 100644 Doc/source/encodings.rst create mode 100644 Doc/source/feaLib.rst create mode 100644 Doc/source/index.rst create mode 100644 Doc/source/inspect.rst create mode 100644 Doc/source/merge.rst create mode 100644 Doc/source/misc/arrayTools.rst create mode 100644 Doc/source/misc/bezierTools.rst create mode 100644 Doc/source/misc/classifyTools.rst create mode 100644 Doc/source/misc/eexec.rst create mode 100644 Doc/source/misc/encodingTools.rst create mode 100644 Doc/source/misc/fixedTools.rst create mode 100644 Doc/source/misc/index.rst create mode 100644 Doc/source/misc/loggingTools.rst create mode 100644 Doc/source/misc/psCharStrings.rst create mode 100644 Doc/source/misc/sstruct.rst create mode 100644 Doc/source/misc/testTools.rst create mode 100644 Doc/source/misc/textTools.rst create mode 100644 Doc/source/misc/timeTools.rst create mode 100644 Doc/source/misc/transform.rst create mode 100644 Doc/source/misc/xmlReader.rst create mode 100644 Doc/source/misc/xmlWriter.rst create mode 100644 Doc/source/pens/areaPen.rst create mode 100644 Doc/source/pens/basePen.rst create mode 100644 Doc/source/pens/boundsPen.rst create mode 100644 Doc/source/pens/filterPen.rst create mode 100644 Doc/source/pens/index.rst create mode 100644 Doc/source/pens/perimeterPen.rst create mode 100644 Doc/source/pens/pointInsidePen.rst create mode 100644 Doc/source/pens/recordingPen.rst create mode 100644 Doc/source/pens/statisticsPen.rst create mode 100644 Doc/source/pens/t2CharStringPen.rst create mode 100644 Doc/source/pens/teePen.rst create mode 100644 Doc/source/pens/transformPen.rst create mode 100644 Doc/source/subset.rst create mode 100644 Doc/source/t1Lib.rst create mode 100644 Doc/source/ttLib/index.rst create mode 100644 Doc/source/ttLib/macUtils.rst create mode 100644 Doc/source/ttLib/sfnt.rst create mode 100644 Doc/source/ttLib/tables.rst create mode 100644 Doc/source/ttLib/woff2.rst create mode 100644 Doc/source/ttx.rst create mode 100644 Doc/source/varLib/designspace.rst create mode 100644 Doc/source/varLib/index.rst create mode 100644 Doc/source/varLib/interpolatable.rst create mode 100644 Doc/source/varLib/interpolate_layout.rst create mode 100644 Doc/source/varLib/merger.rst create mode 100644 Doc/source/varLib/models.rst create mode 100644 Doc/source/varLib/mutator.rst create mode 100644 Doc/source/voltLib.rst diff --git a/Doc/Makefile b/Doc/Makefile new file mode 100644 index 000000000..af18dd88c --- /dev/null +++ b/Doc/Makefile @@ -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) \ No newline at end of file diff --git a/Doc/make.bat b/Doc/make.bat new file mode 100644 index 000000000..81a851af9 --- /dev/null +++ b/Doc/make.bat @@ -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 diff --git a/Doc/man/man1/ttx.1 b/Doc/man/man1/ttx.1 deleted file mode 100644 index 24ce9c174..000000000 --- a/Doc/man/man1/ttx.1 +++ /dev/null @@ -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: diff --git a/Doc/source/afmLib.rst b/Doc/source/afmLib.rst new file mode 100644 index 000000000..f56d3c1b9 --- /dev/null +++ b/Doc/source/afmLib.rst @@ -0,0 +1,7 @@ +###### +afmLib +###### + +.. automodule:: fontTools.afmLib + :members: + :undoc-members: diff --git a/Doc/source/agl.rst b/Doc/source/agl.rst new file mode 100644 index 000000000..0ecf14d0b --- /dev/null +++ b/Doc/source/agl.rst @@ -0,0 +1,7 @@ +### +agl +### + +.. automodule:: fontTools.agl + :members: + :undoc-members: diff --git a/Doc/source/cffLib.rst b/Doc/source/cffLib.rst new file mode 100644 index 000000000..364824f45 --- /dev/null +++ b/Doc/source/cffLib.rst @@ -0,0 +1,7 @@ +###### +cffLib +###### + +.. automodule:: fontTools.cffLib + :members: + :undoc-members: diff --git a/Doc/source/conf.py b/Doc/source/conf.py new file mode 100644 index 000000000..a3b2be2a3 --- /dev/null +++ b/Doc/source/conf.py @@ -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'), +] + diff --git a/Doc/source/encodings.rst b/Doc/source/encodings.rst new file mode 100644 index 000000000..8bcd38a23 --- /dev/null +++ b/Doc/source/encodings.rst @@ -0,0 +1,14 @@ +######### +encodings +######### + +.. automodule:: fontTools.encodings + :members: + :undoc-members: + +codecs +------ + +.. automodule:: fontTools.encodings.codecs + :members: + :undoc-members: diff --git a/Doc/source/feaLib.rst b/Doc/source/feaLib.rst new file mode 100644 index 000000000..ad69217cd --- /dev/null +++ b/Doc/source/feaLib.rst @@ -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: + diff --git a/Doc/source/index.rst b/Doc/source/index.rst new file mode 100644 index 000000000..a64dbe877 --- /dev/null +++ b/Doc/source/index.rst @@ -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` diff --git a/Doc/source/inspect.rst b/Doc/source/inspect.rst new file mode 100644 index 000000000..e0f65c2db --- /dev/null +++ b/Doc/source/inspect.rst @@ -0,0 +1,7 @@ +####### +inspect +####### + +.. automodule:: fontTools.inspect + :members: + :undoc-members: diff --git a/Doc/source/merge.rst b/Doc/source/merge.rst new file mode 100644 index 000000000..74cf9ade3 --- /dev/null +++ b/Doc/source/merge.rst @@ -0,0 +1,7 @@ +##### +merge +##### + +.. automodule:: fontTools.merge + :members: + :undoc-members: diff --git a/Doc/source/misc/arrayTools.rst b/Doc/source/misc/arrayTools.rst new file mode 100644 index 000000000..acb2a5150 --- /dev/null +++ b/Doc/source/misc/arrayTools.rst @@ -0,0 +1,7 @@ +########## +arrayTools +########## + +.. automodule:: fontTools.misc.arrayTools + :members: + :undoc-members: diff --git a/Doc/source/misc/bezierTools.rst b/Doc/source/misc/bezierTools.rst new file mode 100644 index 000000000..c5b4d2a79 --- /dev/null +++ b/Doc/source/misc/bezierTools.rst @@ -0,0 +1,7 @@ +########### +bezierTools +########### + +.. automodule:: fontTools.misc.bezierTools + :members: + :undoc-members: diff --git a/Doc/source/misc/classifyTools.rst b/Doc/source/misc/classifyTools.rst new file mode 100644 index 000000000..b02b35098 --- /dev/null +++ b/Doc/source/misc/classifyTools.rst @@ -0,0 +1,7 @@ +############# +classifyTools +############# + +.. automodule:: fontTools.misc.classifyTools + :members: + :undoc-members: diff --git a/Doc/source/misc/eexec.rst b/Doc/source/misc/eexec.rst new file mode 100644 index 000000000..8506f8636 --- /dev/null +++ b/Doc/source/misc/eexec.rst @@ -0,0 +1,7 @@ +##### +eexec +##### + +.. automodule:: fontTools.misc.eexec + :members: + :undoc-members: diff --git a/Doc/source/misc/encodingTools.rst b/Doc/source/misc/encodingTools.rst new file mode 100644 index 000000000..ff29f6680 --- /dev/null +++ b/Doc/source/misc/encodingTools.rst @@ -0,0 +1,7 @@ +############# +encodingTools +############# + +.. automodule:: fontTools.misc.encodingTools + :members: + :undoc-members: diff --git a/Doc/source/misc/fixedTools.rst b/Doc/source/misc/fixedTools.rst new file mode 100644 index 000000000..30a1f028c --- /dev/null +++ b/Doc/source/misc/fixedTools.rst @@ -0,0 +1,7 @@ +########## +fixedTools +########## + +.. automodule:: fontTools.misc.fixedTools + :members: + :undoc-members: diff --git a/Doc/source/misc/index.rst b/Doc/source/misc/index.rst new file mode 100644 index 000000000..29a7245c4 --- /dev/null +++ b/Doc/source/misc/index.rst @@ -0,0 +1,23 @@ +#### +misc +#### + +.. toctree:: + :maxdepth: 2 + + arrayTools + bezierTools + classifyTools + eexec + encodingTools + fixedTools + loggingTools + sstruct + psCharStrings + testTools + textTools + timeTools + transform + xmlReader + xmlWriter + diff --git a/Doc/source/misc/loggingTools.rst b/Doc/source/misc/loggingTools.rst new file mode 100644 index 000000000..fb8eab582 --- /dev/null +++ b/Doc/source/misc/loggingTools.rst @@ -0,0 +1,7 @@ +############ +loggingTools +############ + +.. automodule:: fontTools.misc.loggingTools + :members: + :undoc-members: diff --git a/Doc/source/misc/psCharStrings.rst b/Doc/source/misc/psCharStrings.rst new file mode 100644 index 000000000..3dc0dce3d --- /dev/null +++ b/Doc/source/misc/psCharStrings.rst @@ -0,0 +1,7 @@ +############# +psCharStrings +############# + +.. automodule:: fontTools.misc.psCharStrings + :members: + :undoc-members: diff --git a/Doc/source/misc/sstruct.rst b/Doc/source/misc/sstruct.rst new file mode 100644 index 000000000..482aa23fe --- /dev/null +++ b/Doc/source/misc/sstruct.rst @@ -0,0 +1,7 @@ +####### +sstruct +####### + +.. automodule:: fontTools.misc.sstruct + :members: + :undoc-members: diff --git a/Doc/source/misc/testTools.rst b/Doc/source/misc/testTools.rst new file mode 100644 index 000000000..b3215ac4f --- /dev/null +++ b/Doc/source/misc/testTools.rst @@ -0,0 +1,7 @@ +######### +testTools +######### + +.. automodule:: fontTools.misc.testTools + :members: + :undoc-members: diff --git a/Doc/source/misc/textTools.rst b/Doc/source/misc/textTools.rst new file mode 100644 index 000000000..754eb6757 --- /dev/null +++ b/Doc/source/misc/textTools.rst @@ -0,0 +1,7 @@ +######### +textTools +######### + +.. automodule:: fontTools.misc.textTools + :members: + :undoc-members: diff --git a/Doc/source/misc/timeTools.rst b/Doc/source/misc/timeTools.rst new file mode 100644 index 000000000..f8d15081a --- /dev/null +++ b/Doc/source/misc/timeTools.rst @@ -0,0 +1,7 @@ +######### +timeTools +######### + +.. automodule:: fontTools.misc.timeTools + :members: + :undoc-members: diff --git a/Doc/source/misc/transform.rst b/Doc/source/misc/transform.rst new file mode 100644 index 000000000..9517fe026 --- /dev/null +++ b/Doc/source/misc/transform.rst @@ -0,0 +1,7 @@ +######### +transform +######### + +.. automodule:: fontTools.misc.transform + :members: + :undoc-members: diff --git a/Doc/source/misc/xmlReader.rst b/Doc/source/misc/xmlReader.rst new file mode 100644 index 000000000..6e0935452 --- /dev/null +++ b/Doc/source/misc/xmlReader.rst @@ -0,0 +1,7 @@ +######### +xmlReader +######### + +.. automodule:: fontTools.misc.xmlReader + :members: + :undoc-members: diff --git a/Doc/source/misc/xmlWriter.rst b/Doc/source/misc/xmlWriter.rst new file mode 100644 index 000000000..f488183d4 --- /dev/null +++ b/Doc/source/misc/xmlWriter.rst @@ -0,0 +1,7 @@ +######### +xmlWriter +######### + +.. automodule:: fontTools.misc.xmlWriter + :members: + :undoc-members: diff --git a/Doc/source/pens/areaPen.rst b/Doc/source/pens/areaPen.rst new file mode 100644 index 000000000..03a751be5 --- /dev/null +++ b/Doc/source/pens/areaPen.rst @@ -0,0 +1,7 @@ +####### +areaPen +####### + +.. automodule:: fontTools.pens.areaPen + :members: + :undoc-members: diff --git a/Doc/source/pens/basePen.rst b/Doc/source/pens/basePen.rst new file mode 100644 index 000000000..f5965b16c --- /dev/null +++ b/Doc/source/pens/basePen.rst @@ -0,0 +1,7 @@ +####### +basePen +####### + +.. automodule:: fontTools.pens.basePen + :members: + :undoc-members: diff --git a/Doc/source/pens/boundsPen.rst b/Doc/source/pens/boundsPen.rst new file mode 100644 index 000000000..8de562015 --- /dev/null +++ b/Doc/source/pens/boundsPen.rst @@ -0,0 +1,7 @@ +######### +boundsPen +######### + +.. automodule:: fontTools.pens.boundsPen + :members: + :undoc-members: diff --git a/Doc/source/pens/filterPen.rst b/Doc/source/pens/filterPen.rst new file mode 100644 index 000000000..0b484a4c1 --- /dev/null +++ b/Doc/source/pens/filterPen.rst @@ -0,0 +1,7 @@ +######### +filterPen +######### + +.. automodule:: fontTools.pens.filterPen + :members: + :undoc-members: diff --git a/Doc/source/pens/index.rst b/Doc/source/pens/index.rst new file mode 100644 index 000000000..7e5a1926a --- /dev/null +++ b/Doc/source/pens/index.rst @@ -0,0 +1,18 @@ +#### +pens +#### + +.. toctree:: + :maxdepth: 1 + + basePen + boundsPen + pointInsidePen + filterPen + transformPen + t2CharStringPen + statisticsPen + recordingPen + teePen + areaPen + perimeterPen diff --git a/Doc/source/pens/perimeterPen.rst b/Doc/source/pens/perimeterPen.rst new file mode 100644 index 000000000..97feccaa1 --- /dev/null +++ b/Doc/source/pens/perimeterPen.rst @@ -0,0 +1,7 @@ +############ +perimeterPen +############ + +.. automodule:: fontTools.pens.perimeterPen + :members: + :undoc-members: diff --git a/Doc/source/pens/pointInsidePen.rst b/Doc/source/pens/pointInsidePen.rst new file mode 100644 index 000000000..9954e478a --- /dev/null +++ b/Doc/source/pens/pointInsidePen.rst @@ -0,0 +1,7 @@ +############## +pointInsidePen +############## + +.. automodule:: fontTools.pens.pointInsidePen + :members: + :undoc-members: diff --git a/Doc/source/pens/recordingPen.rst b/Doc/source/pens/recordingPen.rst new file mode 100644 index 000000000..69e7ceb5f --- /dev/null +++ b/Doc/source/pens/recordingPen.rst @@ -0,0 +1,7 @@ +############ +recordingPen +############ + +.. automodule:: fontTools.pens.recordingPen + :members: + :undoc-members: diff --git a/Doc/source/pens/statisticsPen.rst b/Doc/source/pens/statisticsPen.rst new file mode 100644 index 000000000..efa16089a --- /dev/null +++ b/Doc/source/pens/statisticsPen.rst @@ -0,0 +1,7 @@ +############# +statisticsPen +############# + +.. automodule:: fontTools.pens.statisticsPen + :members: + :undoc-members: diff --git a/Doc/source/pens/t2CharStringPen.rst b/Doc/source/pens/t2CharStringPen.rst new file mode 100644 index 000000000..d58c67aa0 --- /dev/null +++ b/Doc/source/pens/t2CharStringPen.rst @@ -0,0 +1,7 @@ +############### +t2CharStringPen +############### + +.. automodule:: fontTools.pens.t2CharStringPen + :members: + :undoc-members: diff --git a/Doc/source/pens/teePen.rst b/Doc/source/pens/teePen.rst new file mode 100644 index 000000000..7a0313c7f --- /dev/null +++ b/Doc/source/pens/teePen.rst @@ -0,0 +1,7 @@ +###### +teePen +###### + +.. automodule:: fontTools.pens.teePen + :members: + :undoc-members: diff --git a/Doc/source/pens/transformPen.rst b/Doc/source/pens/transformPen.rst new file mode 100644 index 000000000..5b414f842 --- /dev/null +++ b/Doc/source/pens/transformPen.rst @@ -0,0 +1,7 @@ +############ +transformPen +############ + +.. automodule:: fontTools.pens.transformPen + :members: + :undoc-members: diff --git a/Doc/source/subset.rst b/Doc/source/subset.rst new file mode 100644 index 000000000..a8fff95e3 --- /dev/null +++ b/Doc/source/subset.rst @@ -0,0 +1,7 @@ +###### +subset +###### + +.. automodule:: fontTools.subset + :members: + :undoc-members: diff --git a/Doc/source/t1Lib.rst b/Doc/source/t1Lib.rst new file mode 100644 index 000000000..dcc04380e --- /dev/null +++ b/Doc/source/t1Lib.rst @@ -0,0 +1,7 @@ +##### +t1Lib +##### + +.. automodule:: fontTools.t1Lib + :members: + :undoc-members: diff --git a/Doc/source/ttLib/index.rst b/Doc/source/ttLib/index.rst new file mode 100644 index 000000000..d27393487 --- /dev/null +++ b/Doc/source/ttLib/index.rst @@ -0,0 +1,15 @@ +##### +ttLib +##### + +.. toctree:: + :maxdepth: 1 + + macUtils + sfnt + tables + woff2 + +.. automodule:: fontTools.ttLib + :members: + :undoc-members: diff --git a/Doc/source/ttLib/macUtils.rst b/Doc/source/ttLib/macUtils.rst new file mode 100644 index 000000000..cb014d76f --- /dev/null +++ b/Doc/source/ttLib/macUtils.rst @@ -0,0 +1,7 @@ +######## +macUtils +######## + +.. automodule:: fontTools.ttLib.macUtils + :members: + :undoc-members: diff --git a/Doc/source/ttLib/sfnt.rst b/Doc/source/ttLib/sfnt.rst new file mode 100644 index 000000000..41e303227 --- /dev/null +++ b/Doc/source/ttLib/sfnt.rst @@ -0,0 +1,7 @@ +#### +sfnt +#### + +.. automodule:: fontTools.ttLib.sfnt + :members: + :undoc-members: diff --git a/Doc/source/ttLib/tables.rst b/Doc/source/ttLib/tables.rst new file mode 100644 index 000000000..6ae705fb9 --- /dev/null +++ b/Doc/source/ttLib/tables.rst @@ -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: + + diff --git a/Doc/source/ttLib/woff2.rst b/Doc/source/ttLib/woff2.rst new file mode 100644 index 000000000..0c464be63 --- /dev/null +++ b/Doc/source/ttLib/woff2.rst @@ -0,0 +1,7 @@ +##### +woff2 +##### + +.. automodule:: fontTools.ttLib.woff2 + :members: + :undoc-members: diff --git a/Doc/source/ttx.rst b/Doc/source/ttx.rst new file mode 100644 index 000000000..1c9090150 --- /dev/null +++ b/Doc/source/ttx.rst @@ -0,0 +1,7 @@ +### +ttx +### + +.. automodule:: fontTools.ttx + :members: + :undoc-members: diff --git a/Doc/source/varLib/designspace.rst b/Doc/source/varLib/designspace.rst new file mode 100644 index 000000000..e3bbdf7cc --- /dev/null +++ b/Doc/source/varLib/designspace.rst @@ -0,0 +1,7 @@ +########### +designspace +########### + +.. automodule:: fontTools.varLib.designspace + :members: + :undoc-members: diff --git a/Doc/source/varLib/index.rst b/Doc/source/varLib/index.rst new file mode 100644 index 000000000..0e9f17b8e --- /dev/null +++ b/Doc/source/varLib/index.rst @@ -0,0 +1,17 @@ +###### +varLib +###### + +.. toctree:: + :maxdepth: 2 + + designspace + interpolatable + interpolate_layout + merger + models + mutator + +.. automodule:: fontTools.varLib + :members: + :undoc-members: diff --git a/Doc/source/varLib/interpolatable.rst b/Doc/source/varLib/interpolatable.rst new file mode 100644 index 000000000..969fb6149 --- /dev/null +++ b/Doc/source/varLib/interpolatable.rst @@ -0,0 +1,7 @@ +############## +interpolatable +############## + +.. automodule:: fontTools.varLib.interpolatable + :members: + :undoc-members: diff --git a/Doc/source/varLib/interpolate_layout.rst b/Doc/source/varLib/interpolate_layout.rst new file mode 100644 index 000000000..752f748b0 --- /dev/null +++ b/Doc/source/varLib/interpolate_layout.rst @@ -0,0 +1,7 @@ +################## +interpolate_layout +################## + +.. automodule:: fontTools.varLib.interpolate_layout + :members: + :undoc-members: diff --git a/Doc/source/varLib/merger.rst b/Doc/source/varLib/merger.rst new file mode 100644 index 000000000..37383aa65 --- /dev/null +++ b/Doc/source/varLib/merger.rst @@ -0,0 +1,7 @@ +###### +merger +###### + +.. automodule:: fontTools.varLib.merger + :members: + :undoc-members: diff --git a/Doc/source/varLib/models.rst b/Doc/source/varLib/models.rst new file mode 100644 index 000000000..e6c7fa8ac --- /dev/null +++ b/Doc/source/varLib/models.rst @@ -0,0 +1,7 @@ +###### +models +###### + +.. automodule:: fontTools.varLib.models + :members: + :undoc-members: diff --git a/Doc/source/varLib/mutator.rst b/Doc/source/varLib/mutator.rst new file mode 100644 index 000000000..e606ab867 --- /dev/null +++ b/Doc/source/varLib/mutator.rst @@ -0,0 +1,7 @@ +####### +mutator +####### + +.. automodule:: fontTools.varLib.mutator + :members: + :undoc-members: diff --git a/Doc/source/voltLib.rst b/Doc/source/voltLib.rst new file mode 100644 index 000000000..5906c4c26 --- /dev/null +++ b/Doc/source/voltLib.rst @@ -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: From c826e5d88f4cdb6bd45f9cd56e35ad4eb5db55c2 Mon Sep 17 00:00:00 2001 From: Gustavo Ferreira Date: Mon, 24 Apr 2017 10:42:42 -0300 Subject: [PATCH 2/2] adding Sphinx to dev-requirements.txt, restoring ttx man page --- Doc/man/man1/ttx.1 | 225 +++++++++++++++++++++++++++++++++++++++++++ dev-requirements.txt | 1 + 2 files changed, 226 insertions(+) create mode 100644 Doc/man/man1/ttx.1 diff --git a/Doc/man/man1/ttx.1 b/Doc/man/man1/ttx.1 new file mode 100644 index 000000000..bba23b5e5 --- /dev/null +++ b/Doc/man/man1/ttx.1 @@ -0,0 +1,225 @@ +.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: \ No newline at end of file diff --git a/dev-requirements.txt b/dev-requirements.txt index fb728e261..e8685118b 100644 --- a/dev-requirements.txt +++ b/dev-requirements.txt @@ -1,3 +1,4 @@ pytest>=3.0 tox>=2.5 bumpversion>=0.5.3 +sphinx>=1.5.5 \ No newline at end of file