# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/master/config

# -- Path setup --------------------------------------------------------------

# 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
# sys.path.insert(0, os.path.abspath('.'))


# -- Project information -----------------------------------------------------

import batoid

project = 'batoid'
copyright = '2017-2024, Josh Meyers'
author = 'Josh Meyers'

# The short X.Y version
version = '.'.join(map(str, batoid.__version_tuple__[:3]))
# The full version, including alpha/beta/rc tags
release = batoid.__version__

# -- 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.napoleon',
    'sphinx.ext.autodoc',
    'sphinx.ext.autosummary',
    'sphinx.ext.coverage',
    'sphinx.ext.mathjax',
    'sphinx.ext.viewcode',
    'sphinx.ext.autosectionlabel',
]
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 = True
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 = False
napoleon_use_rtype = False
autodoc_member_order = 'bysource'

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

# 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 pattern also affects 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'

# The reST default role (used for this markup: `text`) to use for all
# documents.
default_role = 'any'


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

# # https://michaelgoerz.net/notes/extending-sphinx-napoleon-docstring-sections.html
# # -- Extensions to the  Napoleon GoogleDocstring class ---------------------
#
# from sphinx.ext.napoleon.docstring import GoogleDocstring
#
# # first, we define new methods for any new sections and add them to the class
# def parse_keys_section(self, section):
#     return self._format_fields('Keys', self._consume_fields())
# GoogleDocstring._parse_keys_section = parse_keys_section
#
# def parse_attributes_section(self, section):
#     return self._format_fields('Attributes', self._consume_fields())
# GoogleDocstring._parse_attributes_section = parse_attributes_section
#
# def parse_class_attributes_section(self, section):
#     return self._format_fields('Class Attributes', self._consume_fields())
# GoogleDocstring._parse_class_attributes_section = parse_class_attributes_section
#
# # we now patch the parse method to guarantee that the the above methods are
# # assigned to the _section dict
# def patched_parse(self):
#     self._sections['keys'] = self._parse_keys_section
#     self._sections['class attributes'] = self._parse_class_attributes_section
#     self._unpatched_parse()
# GoogleDocstring._unpatched_parse = GoogleDocstring._parse
# GoogleDocstring._parse = patched_parse
