# -*- coding: utf-8 -*-
#
# 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.

# 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.
#
import os
import sys
import configurations
from better import better_theme_path

os.environ.setdefault("DJANGO_SETTINGS_MODULE", "atmo.settings")
os.environ.setdefault("DJANGO_CONFIGURATION", "Docs")

sys.path.insert(0, os.path.dirname("."))
sys.path.insert(0, os.path.abspath("."))

# Configure Django for autodoc usage
configurations.setup()

from django.conf import settings  # noqa

# -- 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.autodoc",
    "sphinx.ext.intersphinx",
    "sphinx.ext.viewcode",
    "sphinx.ext.graphviz",
    "sphinx.ext.coverage",
    "sphinxcontrib.spelling",
    "extensions.celery",
    "extensions.django",
]

# Fontpath for blockdiag (truetype font)
# blockdiag_fontpath = '/usr/share/fonts/truetype/ipafont/ipagp.ttf'
blockdiag_html_image_format = "SVG"

# Fontpath for blockdiag (truetype font)
blockdiag_fontpath = "_static/fonts/DejaVuSans.ttf"

blockdiag_antialias = True

blockdiag_transparency = True

graphviz_output_format = "svg"

graphviz_dot_args = [
    "-Nfontsize=9",
    "-Nfontname=Helvetica Neue, Helvetica, Arial, sans-serif",
    "-Efontsize=9",
    "-Efontname=Helvetica Neue, Helvetica, Arial, sans-serif",
    "-Gfontsize=9",
    "-Gfontname=Helvetica Neue, Helvetica, Arial, sans-serif",
]

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


# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
source_suffix = ".rst"

# The master toctree document.
master_doc = "index"

# General information about the project.
project = "ATMO"
copyright = "2017, Mozilla Foundation"
author = "Mozilla Foundation"

# 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 full version, including alpha/beta/rc tags.
version = release = settings.VERSION.get("version", "development")

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]

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

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False


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

html_title = "%s %s" % (project, release)

html_short_title = "Home"

html_logo = None

html_favicon = None

html_show_sphinx = True

html_show_copyright = True

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
html_theme_path = [better_theme_path]
html_theme = "better"

# 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 = {
    "showheader": False,
    "showrelbartop": True,
    "rightsidebar": True,
    "linktotheme": False,
    "cssfiles": ["_static/fonts.css", "_static/style.css"],
    # color of text in the footer, including links; defaults to the
    # value of textcolor
    "footertextcolor": "#666",
}

html_sidebars = {"**": ["localtoc.html", "sourcelink.html", "searchbox.html"]}


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


# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = "ATMOdoc"


# -- 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': '',
    # 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, "ATMO.tex", "ATMO Documentation", "Mozilla Foundation", "manual")
]


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

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [(master_doc, "atmo", "ATMO Documentation", [author], 1)]


# -- 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 = [
    (
        master_doc,
        "ATMO",
        "ATMO Documentation",
        author,
        "ATMO",
        "One line description of project.",
        "Miscellaneous",
    )
]

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
    "python": ("https://docs.python.org/", None),
    "django": (
        "https://docs.djangoproject.com/en/1.11/",
        "https://docs.djangoproject.com/en/1.11/_objects/",
    ),
}

# A list of warning types to suppress arbitrary warning messages.
suppress_warnings = ["image.nonlocal_uri"]

celery_task_prefix = "Task: "

spelling_lang = "en_US"

# spelling_word_list_filename = 'spelling_wordlist.txt'

spelling_ignore_pypi_package_names = True

spelling_ignore_wiki_words = True

spelling_ignore_acronyms = True

spelling_ignore_python_builtins = True

spelling_ignore_importable_modules = True
