text: # -*- coding: utf-8 -*-
  ###########################################################################
  # Copyright (c), The AiiDA team. All rights reserved.                     #
  # This file is part of the AiiDA code.                                    #
  #                                                                         #
  # The code is hosted on GitHub at https://github.com/aiidateam/aiida_core #
  # For further information on the license, see the LICENSE.txt file        #
  # For further information please visit http://www.aiida.net               #
  ###########################################################################
  #
  # aiida documentation build configuration file, created by
  # sphinx-quickstart on Wed Oct 24 11:33:37 2012.
  #
  # 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, os
  
  # Following 3 lines avoid the need of importing load_dbenv() for compiling the
  # documentation -> works also without verdi install
  sys.path.append( os.path.join( os.path.split(__file__)[0],
                                     os.pardir,os.pardir) )
  sys.path.append( os.path.join( os.path.split(__file__)[0],
                                     os.pardir))
  os.environ['DJANGO_SETTINGS_MODULE'] = 'rtd_settings'
  
  import aiida
  from aiida.backends import settings
  
  # 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.5.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.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.imgmath', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode', 'IPython.sphinxext.ipython_console_highlighting', 'IPython.sphinxext.ipython_directive']
  ipython_mplbackend = ""
  
  todo_include_todos = True
  
  # 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'AiiDA'
  copyright = u'2016, ECOLE POLYTECHNIQUE FEDERALE DE LAUSANNE (Theory and Simulation of Materials (THEOS) and National Centre for Computational Design and Discovery of Novel Materials (NCCR MARVEL)), Switzerland and ROBERT BOSCH LLC, USA. All rights reserved'
  
  # 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 = '.'.join(aiida.__version__.split('.')[:2])
  # The full version, including alpha/beta/rc tags.
  release = aiida.__version__
  
  author = "The AiiDA team."
  
  # 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 = []
  
  # 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.  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.
  #html_theme_options = {
  #    "navigation_depth": 5,
  #}
  
  # 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 = 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".
  # TEMPORARILY DISABLED
  #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 = 'aiidadoc'
  
  
  # -- 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', 'aiida.tex', u'AiiDA documentation',
     author.replace(',',r'\and'), '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
  
  # We set that we are in documentation mode - even for local compilation
  settings.IN_DOC_MODE = True
  
  # on_rtd is whether we are on readthedocs.org, this line of code grabbed
  # from docs.readthedocs.org
  # NOTE: it is needed to have these lines before load_dbenv()
  on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
  
  if not on_rtd:  # only import and set the theme if we're building docs locally
      try:
          import sphinx_rtd_theme
          html_theme = 'sphinx_rtd_theme'
          html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
      except ImportError:
          # No sphinx_rtd_theme installed
          pass
      # Loading the dbenv. The backend should be fixed before compiling the
      # documentation.
      from aiida.backends.utils import load_dbenv, is_dbenv_loaded
      if not is_dbenv_loaded():
          load_dbenv()
  else:
      # Back-end settings for readthedocs online documentation.
      # from aiida.backends import settings
      settings.IN_RT_DOC_MODE = True
      settings.BACKEND = "django"
      settings.AIIDADB_PROFILE = "default"
  
  
  def run_apidoc(_):
      """Runs sphinx-apidoc when building the documentation.
  
      Needs to be done in conf.py in order to include the APIdoc in the
      build on readthedocs.
  
      See also https://github.com/rtfd/readthedocs.org/issues/1139
      """
      source_dir = os.path.abspath(os.path.dirname(__file__))
      apidoc_dir = os.path.join(source_dir, 'apidoc')
      package_dir = os.path.join(source_dir, os.pardir, os.pardir, 'aiida')
  
      # In #1139, they suggest the route below, but for me this ended up
      # calling sphinx-build, not sphinx-apidoc
      #from sphinx.apidoc import main
      #main([None, '-e', '-o', apidoc_dir, package_dir, '--force'])
  
      import subprocess
      cmd_path = 'sphinx-apidoc'
      if hasattr(sys, 'real_prefix'):  # Check to see if we are in a virtualenv
          # If we are, assemble the path manually
          cmd_path = os.path.abspath(os.path.join(sys.prefix, 'bin', 'sphinx-apidoc'))
  
      options = [
          '-o', apidoc_dir, package_dir,
          '--private',
          '--force',
          '--no-headings',
          '--module-first',
          '--no-toc',
          '--maxdepth', '4',
      ]
  
      # See https://stackoverflow.com/a/30144019
      env = os.environ.copy()
      env["SPHINX_APIDOC_OPTIONS"] = 'members,special-members,private-members,undoc-members,show-inheritance'
      subprocess.check_call([cmd_path] + options, env=env)
  
  def setup(app):
      app.connect('builder-inited', run_apidoc)
  
  
  # -- Options for manual page output --------------------------------------------
  
  # One entry per manual page. List of tuples
  # (source start file, name, description, authors, manual section).
  man_pages = [
      ('index', 'aiida', u'AiiDA documentation',
       [author], 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', 'aiida', u'AiiDA documentation',
     author, 'aiida', 'Automated Interactive Infrastructure and Database for Computational Science',
     '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'
  
  
  # -- Options for Epub output ---------------------------------------------------
  
  # Bibliographic Dublin Core info.
  epub_title = u'AiiDA'
  epub_author = author
  epub_publisher = author
  epub_copyright = copyright
  
  # 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 = ()
  
  # 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
  
  # otherwise, readthedocs.org uses their theme by default, so no need
  # to specify it
  
  
  # Warnings to ignore when using the -n (nitpicky) option
  # We should ignore any python built-in exception, for instance
  nitpick_ignore = []
  
  for line in open('nitpick-exceptions'):
      if line.strip() == "" or line.startswith("#"):
          continue
      dtype, target = line.split(None, 1)
      target = target.strip()
      nitpick_ignore.append((dtype, target))
  