text: # -*- coding: utf-8 -*-
  #
  # phonopy documentation build configuration file, created by
  # sphinx-quickstart on Mon Apr 13 15:11:21 2009.
  #
  # 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 sphinx_bootstrap_theme
  
  # 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.append(os.path.abspath('.'))
  
  # -- General configuration -----------------------------------------------------
  
  # 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.mathjax']
  
  # 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'
  
  # The master toctree document.
  master_doc = 'index'
  
  # General information about the project.
  project = u'phonopy'
  copyright = u'2009, Atsushi Togo'
  
  # 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 = '2.6'
  # The full version, including alpha/beta/rc tags.
  release = '2.6.1'
  
  # 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 documents that shouldn't be included in the build.
  #unused_docs = []
  
  # List of directories, relative to source directory, that shouldn't be searched
  # for source files.
  exclude_trees = ['_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 = 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 = []
  
  
  # -- Options for HTML output ---------------------------------------------------
  
  # The theme to use for HTML and HTML Help pages.  Major themes that come with
  # Sphinx are currently 'default' and 'sphinxdoc'.
  # html_theme = 'default'
  # html_theme = 'nature'
  html_theme = 'bootstrap'
  # html_theme = 'sphinxbootstrap4theme'
  
  # 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 = {}
  html_theme_options = {
      # Navigation bar title. (Default: ``project`` value)
      'navbar_title': "Phonopy",
  
      # Tab name for entire site. (Default: "Site")
      'navbar_site_name': "Site",
  
      # A list of tuples containing pages or urls to link to.
      # Valid tuples should be in the following forms:
      #    (name, page)                 # a link to a page
      #    (name, "/aa/bb", 1)          # a link to an arbitrary relative url
      #    (name, "http://example.com", True) # arbitrary absolute url
      # Note the "1" or "True" value above as the third argument to indicate
      # an arbitrary url.
      # 'navbar_links': [
      #     ("Examples", "examples"),
      #     ("Link", "http://example.com", True),
      #     ],
      # 'navbar_links': [
      #     ("Tags", "setting-tags"),
      #     ("Options", "command-options"),
      #     ],
  
      # Render the next and previous page links in navbar. (Default: true)
      'navbar_sidebarrel': True,
  
      # Render the current pages TOC in the navbar. (Default: true)
      'navbar_pagenav': True,
  
      # Global TOC depth for "site" navbar tab. (Default: 1)
      # Switching to -1 shows all levels.
      'globaltoc_depth': 1,
  
      # Include hidden TOCs in Site navbar?
      #
      # Note: If this is "false", you cannot have mixed ``:hidden:`` and
      # non-hidden ``toctree`` directives in the same page, or else the build
      # will break.
      #
      # Values: "true" (default) or "false"
      'globaltoc_includehidden': "true",
  
      # HTML navbar class (Default: "navbar") to attach to <div> element.
      # For black navbar, do "navbar navbar-inverse"
      # 'navbar_class': "navbar navbar-inverse",
      'navbar_class': "navbar",
  
      # Fix navigation bar to top of page?
      # Values: "true" (default) or "false"
      'navbar_fixed_top': "true",
  
      # Location of link to source.
      # Options are "nav" (default), "footer" or anything else to exclude.
      # 'source_link_position': "nav",
      'source_link_position': "footer",
  
      # Bootswatch (http://bootswatch.com/) theme.
      #
      # Options are nothing with "" (default) or the name of a valid theme
      # such as "amelia" or "cosmo".
      # 'bootswatch_theme': "united",
      'bootswatch_theme': "cerulean",
  
      # Choose Bootstrap version.
      # Values: "3" (default) or "2" (in quotes)
      'bootstrap_version': "3",
  }
  
  # Add any paths that contain custom themes here, relative to this directory.
  # html_theme_path = []
  html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
  # html_theme_path = [sphinxbootstrap4theme.get_path()]
  
  # The name for this set of Sphinx documents.  If None, it defaults to
  # "<project> v<release> documentation".
  html_title = 'Phonopy v.%s' % release
  
  # 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 sideba.
  # html_logo = 'phonopy-logo.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_use_modindex = 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, 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 = ''
  
  # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
  #html_file_suffix = ''
  
  # Output file base name for HTML help builder.
  htmlhelp_basename = 'phonopydoc'
  
  
  # -- Options for LaTeX output --------------------------------------------------
  
  # The paper size ('letter' or 'a4').
  #latex_paper_size = 'letter'
  
  # The font size ('10pt', '11pt' or '12pt').
  #latex_font_size = '10pt'
  
  # Grouping the document tree into LaTeX files. List of tuples
  # (source start file, target name, title, author, documentclass [howto/manual]).
  latex_documents = [
    ('documentation', 'phonopy.tex', u'phonopy manual',
     u'Atsushi Togo', '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
  
  # Additional stuff for the LaTeX preamble.
  #latex_preamble = ''
  
  # Documents to append as an appendix to all manuals.
  #latex_appendices = []
  
  # If false, no module index is generated.
  #latex_use_modindex = True
  