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.int_fiction import Inform6Lexer
26 from tools.transcript import TranscriptLexer
30 app.add_lexer('inform', Inform6Lexer())
31 app.add_lexer('transcript', TranscriptLexer())
33 # -- General configuration ------------------------------------------------
35 # If your documentation needs a minimal Sphinx version, state it here.
38 # Add any Sphinx extension module names here, as strings. They can be
39 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
46 # Add any paths that contain templates here, relative to this directory.
47 templates_path = ['templates']
49 # The suffix(es) of source filenames.
50 source_suffix = ['.rst']
52 # The encoding of source files.
53 #source_encoding = 'utf-8-sig'
55 # The master toctree document.
58 # General document information.
59 project = u"The Inform Beginner's Guide"
60 author = u"Roger Firth and Sonja Kesserich"
61 copyright = u'2004, ' + author
63 editor = "Dennis G. Jerz"
64 edition = "Third Edition: August 2004"
65 extra = "With a foreword by Graham Nelson"
67 licensetext = codecs.open('LICENSE', encoding='utf-8').read()
69 # The version info for the project you're documenting, acts as replacement
70 # for |version| and |release|, also used in various other places throughout
71 # the built documents.
73 # The short X.Y version.
75 # The full version, including alpha/beta/rc tags.
78 # The language for content autogenerated by Sphinx. Refer to documentation
79 # for a list of supported languages.
81 # This is also used if you do content translation via gettext catalogs.
82 # Usually you set "language" from the command line for these cases.
85 # There are two options for replacing |today|: either, you set today to some
86 # non-false value, then it is used:
88 # Else, today_fmt is used as the format for a strftime call.
89 #today_fmt = '%B %d, %Y'
91 # List of patterns, relative to source directory, that match files and
92 # directories to ignore when looking for source files.
93 exclude_patterns = ['config', 'output']
95 # The reST default role (used for this markup: `text`) to use for all
99 # If true, '()' will be appended to :func: etc. cross-reference text.
100 #add_function_parentheses = True
102 # If true, the current module name will be prepended to all description
103 # unit titles (such as .. function::).
104 #add_module_names = True
106 # If true, sectionauthor and moduleauthor directives will be shown in the
107 # output. They are ignored by default.
108 #show_authors = False
110 # The name of the Pygments (syntax highlighting) style to use.
111 pygments_style = 'default'
113 # The default Pygments highlight language.
114 highlight_language = 'none'
116 # A list of ignored prefixes for module index sorting.
117 #modindex_common_prefix = []
119 # If true, keep warnings as "system message" paragraphs in the built documents.
120 #keep_warnings = False
122 # If true, `todo` and `todoList` produce output, else they produce nothing.
123 todo_include_todos = True
126 # -- Options for HTML output ----------------------------------------------
128 # The theme to use for HTML and HTML Help pages. See the documentation for
129 # a list of builtin themes.
130 html_theme = 'alabaster'
132 # Theme options are theme-specific and customize the look and feel of a theme
133 # further. For a list of options available for each theme, see the
135 html_theme_options = {
136 'font_family': 'Georgia',
137 'head_font_family': 'Georgia',
138 'page_width': '1050px',
139 'show_related': True,
142 # Add any paths that contain custom themes here, relative to this directory.
143 #html_theme_path = []
145 # The name for this set of Sphinx documents. If None, it defaults to
146 # "<project> v<release> documentation".
149 # A shorter title for the navigation bar. Default is the same as html_title.
150 #html_short_title = None
152 # The name of an image file (relative to this directory) to place at the top
156 # The name of an image file (within the static path) to use as favicon of the
157 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
161 # Add any paths that contain custom static files (such as style sheets) here,
162 # relative to this directory. They are copied after the builtin static files,
163 # so a file named "default.css" will overwrite the builtin "default.css".
164 #html_static_path = ['static']
166 # Add any extra paths that contain custom files (such as robots.txt or
167 # .htaccess) here, relative to this directory. These files are copied
168 # directly to the root of the documentation.
169 #html_extra_path = []
171 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
172 # using the given strftime format.
173 #html_last_updated_fmt = '%b %d, %Y'
175 # If true, SmartyPants will be used to convert quotes and dashes to
176 # typographically correct entities.
177 #html_use_smartypants = True
179 # Custom sidebar templates, maps document names to template names.
182 # Additional templates that should be rendered to pages, maps page names to
184 #html_additional_pages = {}
186 # If false, no module index is generated.
187 #html_domain_indices = True
189 # If false, no index is generated.
190 #html_use_index = True
192 # If true, the index is split into individual pages for each letter.
193 #html_split_index = False
195 # If true, links to the reST sources are added to the pages.
196 #html_show_sourcelink = True
198 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
199 #html_show_sphinx = True
201 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
202 #html_show_copyright = True
204 # If true, an OpenSearch description file will be output, and all pages will
205 # contain a <link> tag referring to it. The value of this option must be the
206 # base URL from which the finished HTML is served.
207 #html_use_opensearch = ''
209 # This is the file name suffix for HTML files (e.g. ".xhtml").
210 #html_file_suffix = None
212 # Language to be used for generating the HTML full-text search index.
213 # Sphinx supports the following languages:
214 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
215 # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
216 #html_search_language = 'en'
218 # A dictionary with options for the search language support, empty by default.
219 # Now only 'ja' uses this config value
220 #html_search_options = {'type': 'default'}
222 # The name of a javascript file (relative to the configuration directory) that
223 # implements a search results scorer. If empty, the default will be used.
224 #html_search_scorer = 'scorer.js'
226 # Output file base name for HTML help builder.
227 htmlhelp_basename = 'IBG'
229 # -- Options for LaTeX output ---------------------------------------------
231 # Title page information.
232 latex_image = "harry1"
233 latex_image_title = "First Steps"
234 latex_image_info = "(watercolour and crayon on paper, 2002) Harry Firth (2000-)"
235 latex_image_path = os.path.join('images', latex_image + '.png')
236 latex_additional_files = [latex_image_path]
238 template = string.Template(open('config/preamble.tex').read())
240 latex_contents = r"""
250 # The paper size ('letterpaper' or 'a4paper').
251 'papersize': 'a4paper',
253 # The font size ('10pt', '11pt' or '12pt').
256 # Additional stuff for the LaTeX preamble.
257 'preamble': template.substitute(title=project,
260 imagetitle=latex_image_title,
261 imageinfo=latex_image_info,
265 licensetext=licensetext),
267 'tableofcontents': latex_contents,
271 # Latex figure (float) alignment
272 #'figure_align': 'htbp',
275 # Grouping the document tree into LaTeX files. List of tuples
276 # (source start file, target name, title,
277 # author, documentclass [howto, manual, or own class]).
279 (master_doc, 'IBG.tex', project, author, 'howto'),
282 # The name of an image file (relative to this directory) to place at the top of
286 # For "manual" documents, if this is true, then toplevel headings are parts,
288 #latex_use_parts = False
290 # If true, show page references after internal links.
291 latex_show_pagerefs = False
293 # If true, show URL addresses after external links.
294 #latex_show_urls = False
296 # Documents to append as an appendix to all manuals.
297 #latex_appendices = []
299 # If false, no module index is generated.
300 #latex_domain_indices = True
303 # -- Options for manual page output ---------------------------------------
305 # One entry per manual page. List of tuples
306 # (source start file, name, description, authors, manual section).
308 (master_doc, 'IBG', project, [author], 1)
311 # If true, show URL addresses after external links.
312 #man_show_urls = False
315 # -- Options for Texinfo output -------------------------------------------
317 # Grouping the document tree into Texinfo files. List of tuples
318 # (source start file, target name, title, author,
319 # dir menu entry, description, category)
320 texinfo_documents = [
321 (master_doc, 'ibg', project,
322 author, project, 'Beginner\'s guide to Inform.',
326 # Documents to append as an appendix to all manuals.
327 #texinfo_appendices = []
329 # If false, no module index is generated.
330 #texinfo_domain_indices = True
332 # How to display URL addresses: 'footnote', 'no', or 'inline'.
333 #texinfo_show_urls = 'footnote'
335 # If true, do not generate a @detailmenu in the "Top" node's menu.
336 #texinfo_no_detailmenu = False
339 # -- Options for block diagrams -------------------------------------------
341 # The paths to truetype fonts. blockdiag_fontpath option accepts both
342 # single path string and list of paths.
343 blockdiag_fontpath = []
345 # The path to fontmap definitions.
346 blockdiag_fontmap = ""
348 # Render diagrams in antialias mode or not.
349 blockdiag_antialias = True
351 # Render diagrams as transparency or not.
352 blockdiag_transparency = True
354 # The output image format at generating HTML docs ("PNG" or "SVG").
355 blockdiag_html_image_format = "SVG"
357 # The output image format at generating PDF docs (through LaTeX). ("PNG" or
358 # "PDF"). When a value of PDF is specified, you can get clear diagram
359 # images. In which case, reportlab library is required.
360 blockdiag_latex_image_format = "PNG"
362 # Enable debug mode of blockdiag.
363 blockdiag_debug = False