1# -*- coding: utf-8 -*-
2#
3# fontTools documentation build configuration file, created by
4# sphinx-quickstart on Thu Apr 20 11:07:39 2017.
5#
6# This file is execfile()d with the current directory set to its
7# containing dir.
8#
9# Note that not all possible configuration values are present in this
10# autogenerated file.
11#
12# All configuration values have a default; values that are commented out
13# serve to show the default.
14
15# If extensions (or modules to document with autodoc) are in another directory,
16# add these directories to sys.path here. If the directory is relative to the
17# documentation root, use os.path.abspath to make it absolute, like shown here.
18#
19# import os
20# import sys
21# sys.path.insert(0, os.path.abspath('.'))
22
23
24# -- General configuration ------------------------------------------------
25
26# If your documentation needs a minimal Sphinx version, state it here.
27#
28needs_sphinx = '1.3'
29
30# Add any Sphinx extension module names here, as strings. They can be
31# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
32# ones.
33extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
34
35autodoc_mock_imports = ['gtk']
36
37# Add any paths that contain templates here, relative to this directory.
38templates_path = ['_templates']
39
40# The suffix(es) of source filenames.
41# You can specify multiple suffix as a list of string:
42#
43# source_suffix = ['.rst', '.md']
44source_suffix = '.rst'
45
46# The master toctree document.
47master_doc = 'index'
48
49# General information about the project.
50project = u'fontTools'
51copyright = u'2017, Just van Rossum, Behdad Esfahbod et al.'
52author = u'Just van Rossum, Behdad Esfahbod et al.'
53
54# The version info for the project you're documenting, acts as replacement for
55# |version| and |release|, also used in various other places throughout the
56# built documents.
57#
58# The short X.Y version.
59version = u'3.10'
60# The full version, including alpha/beta/rc tags.
61release = u'3.10'
62
63# The language for content autogenerated by Sphinx. Refer to documentation
64# for a list of supported languages.
65#
66# This is also used if you do content translation via gettext catalogs.
67# Usually you set "language" from the command line for these cases.
68language = None
69
70# List of patterns, relative to source directory, that match files and
71# directories to ignore when looking for source files.
72# This patterns also effect to html_static_path and html_extra_path
73exclude_patterns = []
74
75# The name of the Pygments (syntax highlighting) style to use.
76pygments_style = 'sphinx'
77
78# If true, `todo` and `todoList` produce output, else they produce nothing.
79todo_include_todos = False
80
81
82# -- Options for HTML output ----------------------------------------------
83
84# The theme to use for HTML and HTML Help pages.  See the documentation for
85# a list of builtin themes.
86#
87html_theme = 'classic'
88
89# Theme options are theme-specific and customize the look and feel of a theme
90# further.  For a list of options available for each theme, see the
91# documentation.
92#
93# html_theme_options = {}
94
95# Add any paths that contain custom static files (such as style sheets) here,
96# relative to this directory. They are copied after the builtin static files,
97# so a file named "default.css" will overwrite the builtin "default.css".
98html_static_path = ['_static']
99
100
101# -- Options for HTMLHelp output ------------------------------------------
102
103# Output file base name for HTML help builder.
104htmlhelp_basename = 'fontToolsDoc'
105
106
107# -- Options for LaTeX output ---------------------------------------------
108
109latex_elements = {
110    # The paper size ('letterpaper' or 'a4paper').
111    #
112    # 'papersize': 'letterpaper',
113
114    # The font size ('10pt', '11pt' or '12pt').
115    #
116    # 'pointsize': '10pt',
117
118    # Additional stuff for the LaTeX preamble.
119    #
120    # 'preamble': '',
121
122    # Latex figure (float) alignment
123    #
124    # 'figure_align': 'htbp',
125}
126
127# Grouping the document tree into LaTeX files. List of tuples
128# (source start file, target name, title,
129#  author, documentclass [howto, manual, or own class]).
130latex_documents = [
131    (master_doc, 'fontTools.tex', u'fontTools Documentation',
132     u'Just van Rossum, Behdad Esfahbod et al.', 'manual'),
133]
134
135
136# -- Options for manual page output ---------------------------------------
137
138# One entry per manual page. List of tuples
139# (source start file, name, description, authors, manual section).
140man_pages = [
141    (master_doc, 'fonttools', u'fontTools Documentation',
142     [author], 1)
143]
144
145
146# -- Options for Texinfo output -------------------------------------------
147
148# Grouping the document tree into Texinfo files. List of tuples
149# (source start file, target name, title, author,
150#  dir menu entry, description, category)
151texinfo_documents = [
152    (master_doc, 'fontTools', u'fontTools Documentation',
153     author, 'fontTools', 'A library for manipulating fonts, written in Python.',
154     'Typography'),
155]
156
157