text: # -*- coding: utf-8 -*-
  #
  # Creation Platform Extension Authoring Guide documentation build configuration file, created by
  # sphinx-quickstart on Wed May 15 17:27:50 2013.
  #
  # 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 os
  
  # 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'
  
  import os
  
  # KL highlighting
  import FabricEngine.Sphinx.KL
  
  # 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.autodoc',
    'sphinx.ext.napoleon',
    'sphinx.ext.graphviz',
    'FabricEngine.Sphinx.KL',
    'FabricEngine.Sphinx.DFG',
  ]
  
  # Find exectuable in PATH
  def which(program):
      def is_exe(fpath):
          return os.path.isfile(fpath) and os.access(fpath, os.X_OK)
  
      fpath, fname = os.path.split(program)
      if fpath:
          if is_exe(program):
              return program
      else:
          for path in os.environ["PATH"].split(os.pathsep):
              path = path.strip('"')
              exe_file = os.path.join(path, program)
              if is_exe(exe_file):
                  return exe_file
  
      return None
  
  # location of the graphviz dot file
  buildOS = os.environ['FABRIC_BUILD_OS']
  if buildOS == 'Windows':
    graphviz_dot = which("dot.exe")
  else:
    graphviz_dot = which("dot")
  
  if not graphviz_dot:
    raise Exception("Missing 'dot' executable. Check that GraphViz is installed and that dot.exe cam be found. Define an environment variable GRAPHVIZ_DOT_BIN which points to dot.exe")
  graphviz_output_format = 'svg'
  
  # Add any paths that contain templates here, relative to this directory.
  # templates_path = ['_templates']
  
  # The suffix of source filenames.
  source_suffix = '.rst'
  
  # The encoding of source files.
  #source_encoding = 'utf-8-sig'
  
  # The master toctree document.
  master_doc = 'index'
  
  # General information about the project.
  project = u'{{FABRIC_PRODUCT_NAME}}'
  copyright = u'{{FABRIC_COPYRIGHT_YEARS}} '+'{{FABRIC_COMPANY_NAME}}'[:-1]
  
  # 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 = '{{FABRIC_VERSION}}'
  # The full version, including alpha/beta/rc tags.
  release = '{{FABRIC_VERSION}}'
  
  # 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 = '%B %d, %Y'
  
  # List of patterns, relative to source directory, that match files and
  # directories to ignore when looking for source files.
  exclude_patterns = [
    '_build',
    '*.template.rst',
    '*/*.template.rst',
    ]
  
  # 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 = False
  
  # The name of the Pygments (syntax highlighting) style to use.
  pygments_style = 'sphinx'
  
  # A list of ignored prefixes for module index sorting.
  #modindex_common_prefix = []
  
  # If true, keep warnings as "system message" paragraphs in the built documents.
  #keep_warnings = False
  
  
  # -- 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 = 'default'
  
  # 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.
  fabric_color_sky_blue = "#21a8e0"
  fabric_color_greenish = "#73992b"
  fabric_color_aubergine = "#2e1a2e"
  fabric_color_33pct_gray = "#a8a8a8"
  fabric_color_15pct_gray = "#dadada"
  fabric_color_black = "#000000"
  html_theme_options = {
    "sidebarbgcolor": "#171a1f",
    "sidebartextcolor": "#ffffff",
    "sidebarlinkcolor": "#a8a8a8",
    "relbarbgcolor": "#1c252a",
    "relbartextcolor": "#ffffff",
    "relbarlinkcolor": "#a8a8a8",
    "footerbgcolor": "#000000",
    "footertextcolor": "#a8a8a8"
  }
  
  # 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 = "{{FABRIC_PRODUCT_NAME}} {{FABRIC_VERSION}} Documentation"
  
  # 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 = "images/FE_logo_211_37.png"
  
  # 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 = None
  
  # 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 = '%b %d, %Y'
  
  # 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 = {}
  
  # Additional templates that should be rendered to pages, maps page names to
  # template names.
  #html_additional_pages = {}
  
  # 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 = 'FabricEngineDocs'
  
  
  # -- 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 = [
    ('index', 'CreationPlatformExtensionAuthoringGuide.tex', u'Creation Platform Extension Authoring Guide Documentation',
     u'Fabric Engine Inc.', '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 = [
  #     ('index', 'creationplatformextensionauthoringguide', u'Creation Platform Extension Authoring Guide Documentation',
  #      [u'Fabric Engine Inc.'], 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 = [
  #   ('index', 'CreationPlatformExtensionAuthoringGuide', u'Creation Platform Extension Authoring Guide Documentation',
  #    u'Fabric Engine Inc.', 'CreationPlatformExtensionAuthoringGuide', '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'
  
  # If true, do not generate a @detailmenu in the "Top" node's menu.
  #texinfo_no_detailmenu = False
  
  
  # -- Options for Epub output ---------------------------------------------------
  
  # Bibliographic Dublin Core info.
  epub_title = u'Fabric Engine Guide'
  epub_author = u'Fabric Engine Inc.'
  epub_publisher = u'Fabric Engine Inc.'
  epub_copyright = u'2013, Fabric Engine Inc.'
  
  # The language of the text. It defaults to the language option
  # or en if the language is not set.
  #epub_language = ''
  
  # The scheme of the identifier. Typical schemes are ISBN or URL.
  #epub_scheme = ''
  
  # The unique identifier of the text. This can be a ISBN number
  # or the project homepage.
  #epub_identifier = ''
  
  # A unique identification for the text.
  #epub_uid = ''
  
  # A tuple containing the cover image and cover page html template filenames.
  #epub_cover = ()
  
  # A sequence of (type, uri, title) tuples for the guide element of content.opf.
  #epub_guide = ()
  
  # HTML files that should be inserted before the pages created by sphinx.
  # The format is a list of tuples containing the path and title.
  #epub_pre_files = []
  
  # HTML files shat should be inserted after the pages created by sphinx.
  # The format is a list of tuples containing the path and title.
  #epub_post_files = []
  
  # A list of files that should not be packed into the epub file.
  #epub_exclude_files = []
  
  # The depth of the table of contents in toc.ncx.
  #epub_tocdepth = 3
  
  # Allow duplicate toc entries.
  #epub_tocdup = True
  
  # Fix unsupported image types using the PIL.
  #epub_fix_images = False
  
  # Scale large images.
  #epub_max_image_width = 0
  
  # If 'no', URL addresses will not be shown.
  #epub_show_urls = 'inline'
  
  # If false, no index is generated.
  #epub_use_index = True
  
  rst_epilog = """
  .. |FABRIC_COMPANY_NAME| replace:: %s
  .. |FABRIC_PRODUCT_NAME| replace:: %s
  .. |FABRIC_PRODUCT_NAME_CAMEL_CASE| replace:: %s
  .. |FABRIC_COPYRIGHT| replace:: %s
  .. |FABRIC_VERSION| replace:: %s
  .. |RELNOTES-FABRIC_VERSION| replace:: :ref:`RELNOTES-%s`
  .. |FABRIC_DOC_URL| replace:: http://documentation.fabric-engine.com/FabricEngine/%s/HTML/
  .. |FABRIC_DIST_URL| replace:: http://dist.fabric-engine.com/FabricEngine/%s/
  .. |FABRIC_GITHUB_TRAININGMATERIAL_URL| replace:: http://github.com/fabric-engine/TrainingMaterial/tree/%s/
  .. |FABRIC_WINDOWS_HELLOWORLD_PATH| replace:: ``C:\Program Files\%s\Python\HelloFabric.py``
  .. |FABRIC_LINUX_HELLOWORLD_PATH| replace:: ``/usr/lib64/%s/Python/HelloFabric.py``
  .. |FABRIC_OSX_HELLOWORLD_PATH| replace:: ``/Library/%s/%s/Python/HelloFabric.py``
  .. |FABRIC_DEMOS_ZIP| replace:: ``%s-%s-Demos.zip``
  .. |FABRIC_DEMOS| replace:: ``%s-%s-Demos``
  .. |DOCS_ZIP| replace:: http://documentation.fabric-engine.com/FabricEngine/%s/FabricEngine-Documentation-%s.zip
  """ % (
    "{{FABRIC_COMPANY_NAME}}",
    "{{FABRIC_PRODUCT_NAME}}",
    "{{FABRIC_PRODUCT_NAME_CAMEL_CASE}}",
    "{{FABRIC_COPYRIGHT}}",
    "{{FABRIC_VERSION}}",
    "{{FABRIC_VERSION}}",
    "{{FABRIC_VERSION}}",
    "{{FABRIC_VERSION}}",
    "{{FABRIC_VERSION}}",
    "{{FABRIC_PRODUCT_NAME}}",
    "{{FABRIC_PRODUCT_NAME_CAMEL_CASE}}", 
    "{{FABRIC_PRODUCT_NAME_CAMEL_CASE}}", "{{FABRIC_VERSION}}",
    "{{FABRIC_PRODUCT_NAME_CAMEL_CASE}}", "{{FABRIC_VERSION}}",
    "{{FABRIC_PRODUCT_NAME_CAMEL_CASE}}", "{{FABRIC_VERSION}}",
    "{{FABRIC_VERSION}}", "{{FABRIC_VERSION}}"
  )
  
  def setup(app):
      app.add_stylesheet('custom.css')
  