# All configuration values have a default; values that are commented out
# serve to show the default.
-import sys
import os
-import shlex
+import sys
+import string
+import codecs
# 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.
-sys.path.insert(0, os.path.abspath('tools'))
+sys.path.insert(0, ".")
-from inform import InformLexer
-from transcript import TranscriptLexer
+from tools.int_fiction import Inform6Lexer
+from tools.transcript import TranscriptLexer
# Setup function.
def setup(app):
- app.add_lexer('inform', InformLexer())
+ app.add_lexer('inform', Inform6Lexer())
app.add_lexer('transcript', TranscriptLexer())
# -- General configuration ------------------------------------------------
# ones.
extensions = [
'sphinx.ext.todo',
+ 'tools.blockdiag',
]
# Add any paths that contain templates here, relative to this directory.
# The master toctree document.
master_doc = 'index'
-# General information about the project.
-project = u'Inform Beginner\'s Guide'
-author = u'Roger Firth and Sonja Kesserich'
-copyright = u'2016, ' + author
+# General document information.
+project = u"The Inform Beginner's Guide"
+author = u"Roger Firth and Sonja Kesserich"
+copyright = u'2004, ' + author
+
+editor = "Dennis G. Jerz"
+edition = "Third Edition: August 2004"
+extra = "With a foreword by Graham Nelson"
-# 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.
+licensetext = codecs.open('LICENSE', encoding='utf-8').read()
+
+# 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 = '3'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
-exclude_patterns = ['output']
+exclude_patterns = ['config', 'output', 'tables']
# The reST default role (used for this markup: `text`) to use for all
# documents.
html_theme_options = {
'font_family': 'Georgia',
'head_font_family': 'Georgia',
+ 'page_width': '1050px',
+ 'show_related': True,
}
# Add any paths that contain custom themes here, relative to this directory.
# 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']
+#html_static_path = ['static']
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# -- Options for LaTeX output ---------------------------------------------
+# Title page information.
+latex_image = "harry1"
+latex_image_title = "First Steps"
+latex_image_info = "(watercolour and crayon on paper, 2002) Harry Firth (2000-)"
+latex_image_path = os.path.join('images', latex_image + '.png')
+latex_additional_files = [latex_image_path]
+
+template = string.Template(open('config/preamble.tex').read())
+
+latex_contents = r"""
+\coverpage
+\licensepage
+\historypage
+\contentspage
+\newpage
+\maintext
+"""
+
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
'papersize': 'a4paper',
# The font size ('10pt', '11pt' or '12pt').
- 'pointsize': '10pt',
+ 'pointsize': '12pt',
# Additional stuff for the LaTeX preamble.
- #'preamble': '',
+ 'preamble': template.substitute(title=project,
+ author=author,
+ image=latex_image,
+ imagetitle=latex_image_title,
+ imageinfo=latex_image_info,
+ editor=editor,
+ edition=edition,
+ extra=extra,
+ licensetext=licensetext),
+
+ 'tableofcontents': latex_contents,
+
+ 'fontpkg': '',
# 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, 'IBG.tex', project, author, 'manual'),
+ (master_doc, 'IBG.tex', project, author, 'howto'),
]
# The name of an image file (relative to this directory) to place at the top of
#latex_use_parts = False
# If true, show page references after internal links.
-#latex_show_pagerefs = False
+latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
- (master_doc, 'informbeginnersguide', u'Inform Beginner\'s Guide',
- [author], 1)
+ (master_doc, 'IBG', project, [author], 1)
]
# If true, show URL addresses after external links.
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
- (master_doc, 'ibg', u'Inform Beginner\'s Guide',
- author, 'Inform Beginners Guide', 'Beginner\'s guide to Inform.',
+ (master_doc, 'ibg', project,
+ author, project, 'Beginner\'s guide to Inform.',
'Games'),
]
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
+
+
+# -- Options for block diagrams -------------------------------------------
+
+# The paths to truetype fonts. blockdiag_fontpath option accepts both
+# single path string and list of paths.
+blockdiag_fontpath = []
+
+# The path to fontmap definitions.
+blockdiag_fontmap = ""
+
+# Render diagrams in antialias mode or not.
+blockdiag_antialias = True
+
+# Render diagrams as transparency or not.
+blockdiag_transparency = True
+
+# The output image format at generating HTML docs ("PNG" or "SVG").
+blockdiag_html_image_format = "SVG"
+
+# The output image format at generating PDF docs (through LaTeX). ("PNG" or
+# "PDF"). When a value of PDF is specified, you can get clear diagram
+# images. In which case, reportlab library is required.
+blockdiag_latex_image_format = "PNG"
+
+# Enable debug mode of blockdiag.
+blockdiag_debug = False
projects / ibg.git / blobdiff