1 # -*- coding: utf-8 -*-
3 # Inform Beginner's Guide documentation build configuration file, created by
4 # sphinx-quickstart on Tue Mar 29 07:50:39 2016.
6 # This file is execfile()d with the current directory set to its
9 # Note that not all possible configuration values are present in this
12 # All configuration values have a default; values that are commented out
13 # serve to show the default.
20 # If extensions (or modules to document with autodoc) are in another directory,
21 # add these directories to sys.path here. If the directory is relative to the
22 # documentation root, use os.path.abspath to make it absolute, like shown here.
23 sys.path.insert(0, ".")
25 from tools.transcript import TranscriptLexer
29 app.add_lexer('transcript', TranscriptLexer())
31 # -- General configuration ------------------------------------------------
33 # If your documentation needs a minimal Sphinx version, state it here.
36 # Add any Sphinx extension module names here, as strings. They can be
37 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
44 # Add any paths that contain templates here, relative to this directory.
45 templates_path = ['templates']
47 # The suffix(es) of source filenames.
48 source_suffix = ['.rst']
50 # The encoding of source files.
51 #source_encoding = 'utf-8-sig'
53 # The master toctree document.
56 # General document information.
57 project = u"The Inform Beginner's Guide"
58 author = u"Roger Firth and Sonja Kesserich"
59 copyright = u'2004, ' + author
61 editor = "Dennis G. Jerz"
62 edition = "Third Edition: August 2004"
63 extra = "With a foreword by Graham Nelson"
65 licensetext = codecs.open('LICENSE', encoding='utf-8').read()
67 # The version info for the project you're documenting, acts as replacement
68 # for |version| and |release|, also used in various other places throughout
69 # the built documents.
71 # The short X.Y version.
73 # The full version, including alpha/beta/rc tags.
76 # The language for content autogenerated by Sphinx. Refer to documentation
77 # for a list of supported languages.
79 # This is also used if you do content translation via gettext catalogs.
80 # Usually you set "language" from the command line for these cases.
83 # There are two options for replacing |today|: either, you set today to some
84 # non-false value, then it is used:
86 # Else, today_fmt is used as the format for a strftime call.
87 #today_fmt = '%B %d, %Y'
89 # List of patterns, relative to source directory, that match files and
90 # directories to ignore when looking for source files.
91 exclude_patterns = ['config', 'output']
93 # The reST default role (used for this markup: `text`) to use for all
97 # If true, '()' will be appended to :func: etc. cross-reference text.
98 #add_function_parentheses = True
100 # If true, the current module name will be prepended to all description
101 # unit titles (such as .. function::).
102 #add_module_names = True
104 # If true, sectionauthor and moduleauthor directives will be shown in the
105 # output. They are ignored by default.
106 #show_authors = False
108 # The name of the Pygments (syntax highlighting) style to use.
109 pygments_style = 'default'
111 # The default Pygments highlight language.
112 highlight_language = 'none'
114 # A list of ignored prefixes for module index sorting.
115 #modindex_common_prefix = []
117 # If true, keep warnings as "system message" paragraphs in the built documents.
118 #keep_warnings = False
120 # If true, `todo` and `todoList` produce output, else they produce nothing.
121 todo_include_todos = True
124 # -- Options for HTML output ----------------------------------------------
126 # The theme to use for HTML and HTML Help pages. See the documentation for
127 # a list of builtin themes.
128 html_theme = 'alabaster'
130 # Theme options are theme-specific and customize the look and feel of a theme
131 # further. For a list of options available for each theme, see the
133 html_theme_options = {
134 'font_family': 'Georgia',
135 'head_font_family': 'Georgia',
136 'page_width': '1050px',
137 'show_related': True,
140 # Add any paths that contain custom themes here, relative to this directory.
141 #html_theme_path = []
143 # The name for this set of Sphinx documents. If None, it defaults to
144 # "<project> v<release> documentation".
147 # A shorter title for the navigation bar. Default is the same as html_title.
148 #html_short_title = None
150 # The name of an image file (relative to this directory) to place at the top
154 # The name of an image file (within the static path) to use as favicon of the
155 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
159 # Add any paths that contain custom static files (such as style sheets) here,
160 # relative to this directory. They are copied after the builtin static files,
161 # so a file named "default.css" will overwrite the builtin "default.css".
162 #html_static_path = ['static']
164 # Add any extra paths that contain custom files (such as robots.txt or
165 # .htaccess) here, relative to this directory. These files are copied
166 # directly to the root of the documentation.
167 #html_extra_path = []
169 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
170 # using the given strftime format.
171 #html_last_updated_fmt = '%b %d, %Y'
173 # If true, SmartyPants will be used to convert quotes and dashes to
174 # typographically correct entities.
175 #html_use_smartypants = True
177 # Custom sidebar templates, maps document names to template names.
180 # Additional templates that should be rendered to pages, maps page names to
182 #html_additional_pages = {}
184 # If false, no module index is generated.
185 #html_domain_indices = True
187 # If false, no index is generated.
188 #html_use_index = True
190 # If true, the index is split into individual pages for each letter.
191 #html_split_index = False
193 # If true, links to the reST sources are added to the pages.
194 #html_show_sourcelink = True
196 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
197 #html_show_sphinx = True
199 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
200 #html_show_copyright = True
202 # If true, an OpenSearch description file will be output, and all pages will
203 # contain a <link> tag referring to it. The value of this option must be the
204 # base URL from which the finished HTML is served.
205 #html_use_opensearch = ''
207 # This is the file name suffix for HTML files (e.g. ".xhtml").
208 #html_file_suffix = None
210 # Language to be used for generating the HTML full-text search index.
211 # Sphinx supports the following languages:
212 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
213 # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
214 #html_search_language = 'en'
216 # A dictionary with options for the search language support, empty by default.
217 # Now only 'ja' uses this config value
218 #html_search_options = {'type': 'default'}
220 # The name of a javascript file (relative to the configuration directory) that
221 # implements a search results scorer. If empty, the default will be used.
222 #html_search_scorer = 'scorer.js'
224 # Output file base name for HTML help builder.
225 htmlhelp_basename = 'IBG'
227 # -- Options for LaTeX output ---------------------------------------------
229 # Title page information.
230 latex_image = "harry1"
231 latex_image_title = "First Steps"
232 latex_image_info = "(watercolour and crayon on paper, 2002) Harry Firth (2000-)"
233 latex_image_path = os.path.join('images', latex_image + '.png')
234 latex_additional_files = [latex_image_path]
236 template = string.Template(open('config/preamble.tex').read())
238 latex_contents = r"""
248 # The paper size ('letterpaper' or 'a4paper').
249 'papersize': 'a4paper',
251 # The font size ('10pt', '11pt' or '12pt').
254 # Additional stuff for the LaTeX preamble.
255 'preamble': template.substitute(title=project,
258 imagetitle=latex_image_title,
259 imageinfo=latex_image_info,
263 licensetext=licensetext),
265 'tableofcontents': latex_contents,
269 # Latex figure (float) alignment
270 #'figure_align': 'htbp',
273 # Grouping the document tree into LaTeX files. List of tuples
274 # (source start file, target name, title,
275 # author, documentclass [howto, manual, or own class]).
277 (master_doc, 'IBG.tex', project, author, 'howto'),
280 # The name of an image file (relative to this directory) to place at the top of
284 # For "manual" documents, if this is true, then toplevel headings are parts,
286 #latex_use_parts = False
288 # If true, show page references after internal links.
289 latex_show_pagerefs = False
291 # If true, show URL addresses after external links.
292 #latex_show_urls = False
294 # Documents to append as an appendix to all manuals.
295 #latex_appendices = []
297 # If false, no module index is generated.
298 #latex_domain_indices = True
301 # -- Options for manual page output ---------------------------------------
303 # One entry per manual page. List of tuples
304 # (source start file, name, description, authors, manual section).
306 (master_doc, 'IBG', project, [author], 1)
309 # If true, show URL addresses after external links.
310 #man_show_urls = False
313 # -- Options for Texinfo output -------------------------------------------
315 # Grouping the document tree into Texinfo files. List of tuples
316 # (source start file, target name, title, author,
317 # dir menu entry, description, category)
318 texinfo_documents = [
319 (master_doc, 'ibg', project,
320 author, project, 'Beginner\'s guide to Inform.',
324 # Documents to append as an appendix to all manuals.
325 #texinfo_appendices = []
327 # If false, no module index is generated.
328 #texinfo_domain_indices = True
330 # How to display URL addresses: 'footnote', 'no', or 'inline'.
331 #texinfo_show_urls = 'footnote'
333 # If true, do not generate a @detailmenu in the "Top" node's menu.
334 #texinfo_no_detailmenu = False
337 # -- Options for block diagrams -------------------------------------------
339 # The paths to truetype fonts. blockdiag_fontpath option accepts both
340 # single path string and list of paths.
341 blockdiag_fontpath = []
343 # The path to fontmap definitions.
344 blockdiag_fontmap = ""
346 # Render diagrams in antialias mode or not.
347 blockdiag_antialias = True
349 # Render diagrams as transparency or not.
350 blockdiag_transparency = True
352 # The output image format at generating HTML docs ("PNG" or "SVG").
353 blockdiag_html_image_format = "SVG"
355 # The output image format at generating PDF docs (through LaTeX). ("PNG" or
356 # "PDF"). When a value of PDF is specified, you can get clear diagram
357 # images. In which case, reportlab library is required.
358 blockdiag_latex_image_format = "PNG"
360 # Enable debug mode of blockdiag.
361 blockdiag_debug = False