docs/conf.py - third_party/swift - Git at Google

 # -*- coding: utf-8 -*-
 #
 # Swift documentation build configuration file.
 #
 # This file is execfile()d with the current directory set to its containing
 # dir.
 #
 # Note that not all possible configuration values are present in this
 # autogenerated file.
 #
 # All configuration values have a default; values that are commented out
 # serve to show the default.

 import sys
 from datetime import date

 # 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('.'))

 # -- General configuration -----------------------------------------------

 # If your documentation needs a minimal Sphinx version, state it here.
 # needs_sphinx = '1.0'

 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.todo']

 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates', 'archive']

 # The suffix of source filenames.
 source_suffix = '.rst'

 # The encoding of source files.
 # source_encoding = 'utf-8-sig'

 # The master toctree document.
 master_doc = 'contents'

 # General information about the project.
 project = u'Swift'
 copyright = str(date.today().year) + u', Apple Inc'

 # 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.0'
 # The full version, including alpha/beta/rc tags.
 release = '3.0'

 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 # language = None

 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
 # today = ''
 # Else, today_fmt is used as the format for a strftime call.
 today_fmt = '%Y-%m-%d'

 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 exclude_patterns = ['_build']

 # The reST default role (used for this markup: `text`) to use for all
 # documents.
 # default_role = None

 # If true, '()' will be appended to :func: etc. cross-reference text.
 # add_function_parentheses = True

 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
 # add_module_names = True

 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
 show_authors = True

 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'friendly'

 highlight_language = 'swift'

 # A list of ignored prefixes for module index sorting.
 # modindex_common_prefix = []


 # -- Options for HTML output ---------------------------------------------

 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 html_theme = 'haiku'

 html_style = 'swift.css'

 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 html_theme_options = {
     # Red links are a bit too garish
     "linkcolor": "#577492",
     "visitedlinkcolor": "#577492",
     "hoverlinkcolor": "#551A8B"
 }

 # Add any paths that contain custom themes here, relative to this directory.
 html_theme_path = ["."]

 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
 # html_title = None

 # A shorter title for the navigation bar.  Default is the same as html_title.
 # html_short_title = None

 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
 # html_logo = None

 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
 html_favicon = 'favicon.ico'

 # 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']

 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
 html_last_updated_fmt = '%Y-%m-%d'

 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
 # html_use_smartypants = True

 # Custom sidebar templates, maps document names to template names.
 # html_sidebars = {'index': 'indexsidebar.html'}

 # Additional templates that should be rendered to pages, maps page names to
 # template names.
 html_additional_pages = {'archive/LangRef': 'LangRef.html'}

 # If false, no module index is generated.
 # html_domain_indices = True

 # If false, no index is generated.
 # html_use_index = True

 # If true, the index is split into individual pages for each letter.
 # html_split_index = False

 # If true, links to the reST sources are added to the pages.
 html_show_sourcelink = True

 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
 # html_show_sphinx = True

 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
 # html_show_copyright = True

 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
 # html_use_opensearch = ''

 # This is the file name suffix for HTML files (e.g. ".xhtml").
 # html_file_suffix = None

 # Output file base name for HTML help builder.
 htmlhelp_basename = 'Swiftdoc'


 # -- Options for LaTeX output --------------------------------------------

 latex_elements = {
     # The paper size ('letterpaper' or 'a4paper').
     # 'papersize': 'letterpaper',

     # The font size ('10pt', '11pt' or '12pt').
     # 'pointsize': '10pt',

     # Additional stuff for the LaTeX preamble.
     # 'preamble': '',
 }

 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass
 # [howto/manual]).
 latex_documents = [
     ('contents', 'Swift.tex', u'Swift Documentation',
      u'LLVM project', 'manual'),
 ]

 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
 # latex_logo = None

 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
 # latex_use_parts = False

 # If true, show page references after internal links.
 # latex_show_pagerefs = False

 # If true, show URL addresses after external links.
 # latex_show_urls = False

 # Documents to append as an appendix to all manuals.
 # latex_appendices = []

 # If false, no module index is generated.
 # latex_domain_indices = True


 # -- Options for manual page output --------------------------------------

 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
     ('contents', 'Swift', u'Swift Documentation',
      [u'LLVM project'], 1)
 ]

 # If true, show URL addresses after external links.
 # man_show_urls = False


 # -- Options for Texinfo output ------------------------------------------

 # Grouping the document tree into Texinfo files. List of tuples
 # (source start file, target name, title, author,
 # dir menu entry, description, category)
 texinfo_documents = [
     ('contents', 'Swift', u'Swift Documentation',
      u'LLVM project', 'Swift', 'One line description of project.',
      'Miscellaneous'),
 ]

 # Documents to append as an appendix to all manuals.
 # texinfo_appendices = []

 # If false, no module index is generated.
 # texinfo_domain_indices = True

 # How to display URL addresses: 'footnote', 'no', or 'inline'.
 # texinfo_show_urls = 'footnote'


 # FIXME: Define intersphinx configuration.
 intersphinx_mapping = {}


 # -- Options for extensions ----------------------------------------------

 # Enable this if you want TODOs to show up in the generated documentation.
 todo_include_todos = True

 #
 # Monkeypatch pygments so it will know about the Swift lexers
 #

 # Pull in the Swift lexers
 from os.path import abspath, dirname, join as join_paths  # noqa (E402)
 sys.path = [
     join_paths(dirname(dirname(abspath(__file__))), 'utils', 'pygments')
 ] + sys.path

 import swift as swift_pygments_lexers  # noqa (E402 module level import not at top of file)

 sys.path.pop(0)

 # Monkeypatch pygments.lexers.get_lexer_by_name to return our lexers. The
 # ordering required to allow for monkeypatching causes the warning
 # "I100 Import statements are in the wrong order." when linting using
 # flake8-import-order. "noqa" is used to suppress this warning.
 from pygments.lexers import get_lexer_by_name as original_get_lexer_by_name  # noqa (E402)


 def swift_get_lexer_by_name(_alias, *args, **kw):
     if _alias == 'swift':
         return swift_pygments_lexers.SwiftLexer()
     elif _alias == 'sil':
         return swift_pygments_lexers.SILLexer()
     elif _alias == 'swift-console':
         return swift_pygments_lexers.SwiftConsoleLexer()
     else:
         return original_get_lexer_by_name(_alias, *args, **kw)

 import pygments.lexers  # noqa (I100 Import statements are in the wrong order.)
 pygments.lexers.get_lexer_by_name = swift_get_lexer_by_name
	# -- coding: utf-8 --
	#
	# Swift documentation build configuration file.
	#
	# This file is execfile()d with the current directory set to its containing
	# dir.
	#
	# Note that not all possible configuration values are present in this
	# autogenerated file.
	#
	# All configuration values have a default; values that are commented out
	# serve to show the default.

	import sys
	from datetime import date

	# 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('.'))

	# -- General configuration -----------------------------------------------

	# If your documentation needs a minimal Sphinx version, state it here.
	# needs_sphinx = '1.0'

	# Add any Sphinx extension module names here, as strings. They can be
	# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
	extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.todo']

	# Add any paths that contain templates here, relative to this directory.
	templates_path = ['_templates', 'archive']

	# The suffix of source filenames.
	source_suffix = '.rst'

	# The encoding of source files.
	# source_encoding = 'utf-8-sig'

	# The master toctree document.
	master_doc = 'contents'

	# General information about the project.
	project = u'Swift'
	copyright = str(date.today().year) + u', Apple Inc'

	# 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.0'
	# The full version, including alpha/beta/rc tags.
	release = '3.0'

	# The language for content autogenerated by Sphinx. Refer to documentation
	# for a list of supported languages.
	# language = None

	# There are two options for replacing \|today\|: either, you set today to some
	# non-false value, then it is used:
	# today = ''
	# Else, today_fmt is used as the format for a strftime call.
	today_fmt = '%Y-%m-%d'

	# List of patterns, relative to source directory, that match files and
	# directories to ignore when looking for source files.
	exclude_patterns = ['_build']

	# The reST default role (used for this markup: `text`) to use for all
	# documents.
	# default_role = None

	# If true, '()' will be appended to :func: etc. cross-reference text.
	# add_function_parentheses = True

	# If true, the current module name will be prepended to all description
	# unit titles (such as .. function::).
	# add_module_names = True

	# If true, sectionauthor and moduleauthor directives will be shown in the
	# output. They are ignored by default.
	show_authors = True

	# The name of the Pygments (syntax highlighting) style to use.
	pygments_style = 'friendly'

	highlight_language = 'swift'

	# A list of ignored prefixes for module index sorting.
	# modindex_common_prefix = []


	# -- Options for HTML output ---------------------------------------------

	# The theme to use for HTML and HTML Help pages. See the documentation for
	# a list of builtin themes.
	html_theme = 'haiku'

	html_style = 'swift.css'

	# Theme options are theme-specific and customize the look and feel of a theme
	# further. For a list of options available for each theme, see the
	# documentation.
	html_theme_options = {
	# Red links are a bit too garish
	"linkcolor": "#577492",
	"visitedlinkcolor": "#577492",
	"hoverlinkcolor": "#551A8B"
	}

	# Add any paths that contain custom themes here, relative to this directory.
	html_theme_path = ["."]

	# The name for this set of Sphinx documents. If None, it defaults to
	# "<project> v<release> documentation".
	# html_title = None

	# A shorter title for the navigation bar. Default is the same as html_title.
	# html_short_title = None

	# The name of an image file (relative to this directory) to place at the top
	# of the sidebar.
	# html_logo = None

	# The name of an image file (within the static path) to use as favicon of the
	# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
	# pixels large.
	html_favicon = 'favicon.ico'

	# 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']

	# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
	# using the given strftime format.
	html_last_updated_fmt = '%Y-%m-%d'

	# If true, SmartyPants will be used to convert quotes and dashes to
	# typographically correct entities.
	# html_use_smartypants = True

	# Custom sidebar templates, maps document names to template names.
	# html_sidebars = {'index': 'indexsidebar.html'}

	# Additional templates that should be rendered to pages, maps page names to
	# template names.
	html_additional_pages = {'archive/LangRef': 'LangRef.html'}

	# If false, no module index is generated.
	# html_domain_indices = True

	# If false, no index is generated.
	# html_use_index = True

	# If true, the index is split into individual pages for each letter.
	# html_split_index = False

	# If true, links to the reST sources are added to the pages.
	html_show_sourcelink = True

	# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
	# html_show_sphinx = True

	# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
	# html_show_copyright = True

	# If true, an OpenSearch description file will be output, and all pages will
	# contain a <link> tag referring to it. The value of this option must be the
	# base URL from which the finished HTML is served.
	# html_use_opensearch = ''

	# This is the file name suffix for HTML files (e.g. ".xhtml").
	# html_file_suffix = None

	# Output file base name for HTML help builder.
	htmlhelp_basename = 'Swiftdoc'


	# -- Options for LaTeX output --------------------------------------------

	latex_elements = {
	# The paper size ('letterpaper' or 'a4paper').
	# 'papersize': 'letterpaper',

	# The font size ('10pt', '11pt' or '12pt').
	# 'pointsize': '10pt',

	# Additional stuff for the LaTeX preamble.
	# 'preamble': '',
	}

	# Grouping the document tree into LaTeX files. List of tuples
	# (source start file, target name, title, author, documentclass
	# [howto/manual]).
	latex_documents = [
	('contents', 'Swift.tex', u'Swift Documentation',
	u'LLVM project', 'manual'),
	]

	# The name of an image file (relative to this directory) to place at the top of
	# the title page.
	# latex_logo = None

	# For "manual" documents, if this is true, then toplevel headings are parts,
	# not chapters.
	# latex_use_parts = False

	# If true, show page references after internal links.
	# latex_show_pagerefs = False

	# If true, show URL addresses after external links.
	# latex_show_urls = False

	# Documents to append as an appendix to all manuals.
	# latex_appendices = []

	# If false, no module index is generated.
	# latex_domain_indices = True


	# -- Options for manual page output --------------------------------------

	# One entry per manual page. List of tuples
	# (source start file, name, description, authors, manual section).
	man_pages = [
	('contents', 'Swift', u'Swift Documentation',
	[u'LLVM project'], 1)
	]

	# If true, show URL addresses after external links.
	# man_show_urls = False


	# -- Options for Texinfo output ------------------------------------------

	# Grouping the document tree into Texinfo files. List of tuples
	# (source start file, target name, title, author,
	# dir menu entry, description, category)
	texinfo_documents = [
	('contents', 'Swift', u'Swift Documentation',
	u'LLVM project', 'Swift', 'One line description of project.',
	'Miscellaneous'),
	]

	# Documents to append as an appendix to all manuals.
	# texinfo_appendices = []

	# If false, no module index is generated.
	# texinfo_domain_indices = True

	# How to display URL addresses: 'footnote', 'no', or 'inline'.
	# texinfo_show_urls = 'footnote'


	# FIXME: Define intersphinx configuration.
	intersphinx_mapping = {}


	# -- Options for extensions ----------------------------------------------

	# Enable this if you want TODOs to show up in the generated documentation.
	todo_include_todos = True

	#
	# Monkeypatch pygments so it will know about the Swift lexers
	#

	# Pull in the Swift lexers
	from os.path import abspath, dirname, join as join_paths # noqa (E402)
	sys.path = [
	join_paths(dirname(dirname(abspath(__file__))), 'utils', 'pygments')
	] + sys.path

	import swift as swift_pygments_lexers # noqa (E402 module level import not at top of file)

	sys.path.pop(0)

	# Monkeypatch pygments.lexers.get_lexer_by_name to return our lexers. The
	# ordering required to allow for monkeypatching causes the warning
	# "I100 Import statements are in the wrong order." when linting using
	# flake8-import-order. "noqa" is used to suppress this warning.
	from pygments.lexers import get_lexer_by_name as original_get_lexer_by_name # noqa (E402)


	def swift_get_lexer_by_name(_alias, args, *kw):
	if _alias == 'swift':
	return swift_pygments_lexers.SwiftLexer()
	elif _alias == 'sil':
	return swift_pygments_lexers.SILLexer()
	elif _alias == 'swift-console':
	return swift_pygments_lexers.SwiftConsoleLexer()
	else:
	return original_get_lexer_by_name(_alias, args, *kw)

	import pygments.lexers # noqa (I100 Import statements are in the wrong order.)
	pygments.lexers.get_lexer_by_name = swift_get_lexer_by_name