X-Git-Url: https://jxself.org/git/?p=ibg.git;a=blobdiff_plain;f=conf.py;h=ec350aeb1feaf2d43598d8790b40e37a4d4ba997;hp=0e3fb332da64b361f2d6c017bb81aa7170dee1df;hb=dc7fec99d92b670126e1e73e05df8f60706edc2d;hpb=32e6323676b92eb33f4d8300e790003303be3cc1 diff --git a/conf.py b/conf.py index 0e3fb33..ec350ae 100644 --- a/conf.py +++ b/conf.py @@ -12,21 +12,22 @@ # 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 ------------------------------------------------ @@ -39,6 +40,7 @@ def setup(app): # ones. extensions = [ 'sphinx.ext.todo', + 'tools.blockdiag', ] # Add any paths that contain templates here, relative to this directory. @@ -53,19 +55,25 @@ source_suffix = ['.rst'] # 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 = '4.0' +version = '3' # The full version, including alpha/beta/rc tags. -release = '4.0' +release = version # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -82,7 +90,7 @@ language = None # 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. @@ -127,6 +135,8 @@ html_theme = 'alabaster' 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. @@ -151,7 +161,7 @@ html_title = project # 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 @@ -218,25 +228,55 @@ htmlhelp_basename = 'IBG' # -- 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 @@ -248,7 +288,7 @@ latex_documents = [ #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 @@ -265,8 +305,7 @@ latex_documents = [ # 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. @@ -279,8 +318,8 @@ man_pages = [ # (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'), ] @@ -295,3 +334,30 @@ texinfo_documents = [ # 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