import os
import sys

import sphinx

# 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('..'))

from msl import equipment

# -- 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.autosummary',
    'sphinx.ext.doctest',
    'sphinx.ext.intersphinx',
    'sphinx.ext.viewcode',
    'sphinx.ext.coverage',
    'sphinx.ext.napoleon',
    'sphinx.ext.todo',
]

# autodoc options
if sphinx.version_info[:2] < (1, 8):
    # 'alphabetical', 'bysource', 'groupwise'
    autodoc_member_order = 'bysource'

    # 'members', 'undoc-members', 'private-members', 'special-members', 'inherited-members', 'show-inheritance'
    autodoc_default_flags = ['members', 'undoc-members', 'show-inheritance']
else:
    autodoc_default_options = {
        'members': None,
        'member-order': 'bysource',
        'undoc-members': None,
        'show-inheritance': None,
    }

# Generate autodoc stubs with summaries from code
autosummary_generate = True

# include both class docstring and __init__
autoclass_content = "both"

# Napoleon settings
napoleon_google_docstring = False
napoleon_numpy_docstring = True
napoleon_include_init_with_doc = False
napoleon_include_private_with_doc = False
napoleon_include_special_with_doc = False
napoleon_use_admonition_for_examples = False
napoleon_use_admonition_for_notes = False
napoleon_use_admonition_for_references = False
napoleon_use_ivar = False
napoleon_use_param = True
napoleon_use_rtype = False

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

# The suffix of source filenames.
source_suffix = '.rst'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = 'MSL-Equipment'
copyright = equipment.__copyright__[1:]
author = equipment.__author__

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

# 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 = 'sphinx'

# If true, to-do and to-doList produce output, else they produce nothing.
todo_include_todos = True


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

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
on_rtd = os.getenv('READTHEDOCS') == 'True'
if on_rtd:
    html_theme = 'default'
else:
    html_theme = 'sphinx_rtd_theme'

# 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 = 'MSL-Equipmentdoc'


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

latex_elements = {
    # The paper size ('letterpaper' or 'a4paper').
    #
    'papersize': 'a4paper',

    # The font size ('10pt', '11pt' or '12pt').
    #
    'pointsize': '11pt',

    # 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, 'MSL-Equipment.tex', 'MSL-Equipment Documentation',
     'Measurement Standards Laboratory of New Zealand', '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, 'MSL-Equipment', 'MSL-Equipment 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, 'MSL-Equipment', 'MSL-Equipment Documentation',
     author, 'MSL-Equipment', 'MSL-Equipment',
     'Miscellaneous'),
]


# -- Options for Epub output ----------------------------------------------

# Bibliographic Dublin Core info.
epub_title = project
epub_author = author
epub_publisher = author
epub_copyright = copyright

# 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 list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
    'python': ('https://docs.python.org/3', None),
    'numpy': ('https://numpy.org/doc/stable/', None),
    'msl.loadlib': ('https://msl-loadlib.readthedocs.io/en/stable/', None),
    'pyvisa': ('https://pyvisa.readthedocs.io/en/stable/', None),
    'pyserial': ('https://pyserial.readthedocs.io/en/stable/', None),
    'nidaqmx': ('https://nidaqmx-python.readthedocs.io/en/stable/', None),
    'msl.io': ('https://msl-io.readthedocs.io/en/latest/', None),  # TODO replace latest with stable after releasing
}

# warn about all broken links
nitpicky = True

# known bad links
nitpick_ignore = [
    ('py:class', '_ctypes.Structure'),
    ('py:class', 'ctypes.WINFUNCTYPE.<locals>.WinFunctionType'),
    ('py:class', 'ctypes.CFUNCTYPE.<locals>.CFunctionType'),
    ('py:mod', 'nidaqmx.system'),
]

@@ -2902,20 +2902,20 @@
 guage = 
-None
+'en'
 %0A%0A# List

set the language in conf.py to be 'en'