# -*- coding: utf-8 -*-

####################################################################################################
#
# KiCadRW - Python library to read/write KiCad Sexpr file format
# Copyright (C) 2017 Salvaire Fabrice
#
####################################################################################################

####################################################################################################
#
# KiCadRW documentation build configuration file, created by
# sphinx-quickstart on Fri Apr  8 16:54:03 2014.
#
# 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 pathlib

import sys, os
from datetime import datetime

# http://www.sphinx-doc.org/en/stable/extdev/logging.html
# from sphinx.util import logging
import logging
logger = logging.getLogger(__name__)

try:
    import sphinx_rtd_theme
except:
    logger.warning('Failed to import sphinx_rtd_theme')
    pass

import KiCadRW

####################################################################################################

# 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.
# for directory in ,:

kicad-rw_path = pathlib.Path(__file__).parents[3]
sys.path.insert(0, str(kicad-rw_path))

####################################################################################################

exec(compile(open(kicad-rw_path.joinpath('setup_data.py')).read(), 'setup_data.py', 'exec'))

####################################################################################################
#
# 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.doctest',
              'sphinx.ext.intersphinx',
              'sphinx.ext.todo',
              'sphinx.ext.coverage',
              # 'sphinx.ext.pngmath',
              'sphinx.ext.mathjax',
              'sphinx.ext.ifconfig',
              'sphinx.ext.viewcode',
              'sphinxcontrib.getthecode',
              ]

# 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 = 'KiCadRW'
copyright = '{0.year}, Fabrice Salvaire'.format(datetime.now())

# 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.
release = KiCadRW.__version__
# The short X.Y version.
version = '.'.join(release.split('.')[:2])

# 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 Autodoc
#

# Show both class-level docstring and __init__ docstring in class documentation
autoclass_content = 'both'
autodoc_default_flags = [
    'members',
    'undoc-members',
    # 'private-members',
    # 'special-members',
    # 'inherited-members',
    # 'show-inheritance',
    ]

####################################################################################################
#
# 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 = 'KiCadRW'
html_theme = 'KiCadRWRtd'
# html_theme = 'sphinx_rtd_theme'

# on_rtd is whether we are on readthedocs.org
## on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
## if not on_rtd:  # only import and set the theme if we're building docs locally
##     import sphinx_rtd_theme
##     html_theme = 'sphinx_rtd_theme'
##     html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# otherwise, readthedocs.org uses their theme by default, so no need to specify it

# 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 themes here, relative to this directory.
html_theme_path = ['themes']
# html_theme_path = [sphinx_rtd_theme.get_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".
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 = 'KiCadRW'

####################################################################################################
#
# Options for LaTeX output
#

# The paper size ('letter' or 'a4').
# WARNING: latex_paper_size is deprecated. Use latex_elements['papersize'] instead.
# Fixme: don't work ???
latex_paper_size = 'a4'

# 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 = [
  ('index', 'KiCadRW.tex', 'KiCadRW Documentation', 'Fabrice Salvaire', '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

# 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_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', 'KiCadRW', 'KiCadRW Documentation', ['Fabrice Salvaire'], 1)
]

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'http://docs.python.org/': None}

####################################################################################################
#
# MathJax
#

# Don't work
# mathjax_path = 'MathJax/MathJax.js'

####################################################################################################
#
# Getthecode
#

getthecode_header_template = '''
<div class="getthecode-header">
  <ul>
    {# <li class="getthecode-filename">{{ filename }}</li> #}
    <li class="getthecode-filename-link">
      <a href="{{ url }}" download={{ filename }} type="text/x-python" target="_blank" rel="noreferrer noopener"><span>
        {{ filename }}
        <i class="fa fa-download" aria-hidden="true"></i>
      </span></a>
    </li>
{% if notebook_url %}
    <li class="getthecode-notebook-link">
      <a href="{{ notebook_url }}" download={{ notebook_filename }} type="application/x-ipynb+json" target="_blank" rel="noreferrer noopener"><span>
        {{ notebook_filename }}
        <i class="fa fa-download" aria-hidden="true"></i>
      </span></a>
    </li>

    <li class="getthecode-notebook-link">
      <a href="{{ 'https://nbviewer.jupyter.org/urls/kicad-rw.fabrice-salvaire.fr/releases/v@VERSION@/' + notebook_url|replace('../', '') }}"
         target="_blank" rel="noreferrer noopener"><span>
        Open in nbviewer
         <i class="fa fa-external-link" aria-hidden="true"></i>
      </span></a>
    </li>
{% endif %}
  </ul>
</div>
'''

getthecode_header_template = getthecode_header_template.replace('@VERSION@', version)
