#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# gamma-cat documentation build configuration file, created by
# sphinx-quickstart on Sat Dec 31 14:48:06 2016.
#
# 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
from pathlib import Path

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 = [
    'matplotlib.sphinxext.plot_directive',

    # Bokeh Sphinx extension is broken at the moment. See here:
    # https://github.com/bokeh/bokeh/issues/5951#issuecomment-296948826
    # 'bokeh.sphinxext.bokeh_plot',
    'sphinxcontrib.datatemplates',
    'gammacat.sphinx.exts.rstjinja',
]

# 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', '.md']
source_suffix = '.rst'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = 'gamma-cat'
copyright = '2018, gamma-cat contributors'
author = 'gamma-cat contributors'

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

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


html_extra_path = [
    # 'rawfiles',
    # 'test2.txt',
]

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

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


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

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

# See https://github.com/snide/sphinx_rtd_theme#using-this-theme-locally-then-building-on-read-the-docs
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'

if not on_rtd:
    import sphinx_rtd_theme
    html_theme = 'sphinx_rtd_theme'
    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]


# On RTD, we run `make.py webpage` to run the first part
# of the webpage build (auto-generate RST pages)
# This was added and discussed in https://github.com/gammapy/gamma-cat/pull/172
# Some info what RTD executes is here:
# http://docs.readthedocs.io/en/latest/builds.html#understanding-what-s-going-on
if on_rtd:
    import subprocess

    cwd = Path('..').resolve()
    print('cwd:', cwd)

    cmd = f'{sys.executable} make.py clean'
    print(f'Executing: {cmd}')
    subprocess.call(cmd, cwd=cwd, shell=True)

    cmd = f'{sys.executable} make.py webpage'
    print(f'Executing: {cmd}')
    subprocess.call(cmd, cwd=cwd, shell=True)

# 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 = {}

# 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 = 'gamma-catdoc'


# -- 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, 'gamma-cat.tex', 'gamma-cat Documentation',
     'gamma-cat contributors', '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, 'gamma-cat', 'gamma-cat 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, 'gamma-cat', 'gamma-cat Documentation',
     author, 'gamma-cat', 'One line description of project.',
     'Miscellaneous'),
]


#############################################################################
### gamma-cat additions below
#############################################################################

# from gammacat.info import gammacat_info
#
# gammacat_context = dict(
#     version=gammacat_info.version,
# )
