#!/usr/bin/env python3

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

#

# ANTsPy documentation build configuration file, created by

# sphinx-quickstart on Fri Dec 23 13:31:47 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

import shutil

on_rtd = os.environ.get('READTHEDOCS') == 'True'

    # add package to local path

sys.path.insert(0, os.path.abspath('../../'))

autodoc_mock_imports = ['_tkinter', 'matplotlib']

if on_rtd:

    # replace lib __init__ with empty init file since RTD cant handle C++ extensions

    os.makedirs('../../ants/lib', exist_ok=True)

    shutil.copyfile('emptyinit.py', '../../ants/lib/__init__.py')

import ants

import numpy as np

import sphinx_rtd_theme

# -- 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.todo',

    'sphinx.ext.coverage',

    'sphinx.ext.mathjax',

    'sphinx.ext.napoleon',

    'sphinx.ext.viewcode',

]

napoleon_use_ivar = True

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

copyright = '2017-2024, ANTs Contributors'

author = 'ANTs 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.

#

# Default values for local builds

version = 'local'

release = 'local'

# Determine if we are on Read the Docs

on_rtd = os.environ.get('READTHEDOCS', None) == 'True'

if on_rtd:

    rtd_version = os.environ.get('READTHEDOCS_VERSION', 'local')

    rtd_version_type = os.environ.get('READTHEDOCS_VERSION_TYPE', 'branch')

    if rtd_version_type == 'tag':

        version = rtd_version.lstrip('v')

        release = f'release {version}'

    elif rtd_version_type == 'branch' and rtd_version == 'latest':

        version = 'dev'

        release = f'dev ({rtd_version})'

    else:

        version = rtd_version

        release = rtd_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 = []

# 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 = True

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

#html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

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

#    'collapse_navigation': False,

#    'display_version': True,

#    'logo_only': True,

#}

html_logo = '_static/img/antspy-logo.png'

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

#html_style_path = '_static/css/ants_theme.css'

#html_context = {

#    'css_files': [

#        'https://fonts.googleapis.com/css?family=Lato',

#        '_static/css/ants_theme.css'

#    ],

#}

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

# Output file base name for HTML help builder.

htmlhelp_basename = 'ANTsPydoc'

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

# -- 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, 'ANTsPy', 'ANTsPy 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, 'ANTsPy', 'ANTsPy Documentation',

     author, 'ANTsPy', 'One line description of project.',

     'Miscellaneous'),

]

# Example configuration for intersphinx: refer to the Python standard library.

intersphinx_mapping = {

    'python': ('https://docs.python.org/', None),

    'numpy': ('http://docs.scipy.org/doc/numpy/', None),

}

# -- A patch that prevents Sphinx from cross-referencing ivar tags -------

# See http://stackoverflow.com/a/41184353/3343043

from docutils import nodes

from sphinx.util.docfields import TypedField

from sphinx import addnodes

def patched_make_field(self, types, domain, items, **kw):

    # `kw` catches `env=None` needed for newer sphinx while maingaining

    #  backwards compatibility when passed along further down!

    # type: (List, unicode, Tuple) -> nodes.field

    def handle_item(fieldarg, content):

        par = nodes.paragraph()

        par += addnodes.literal_strong('', fieldarg)  # Patch: this line added

        # par.extend(self.make_xrefs(self.rolename, domain, fieldarg,

        #                           addnodes.literal_strong))

        if fieldarg in types:

            par += nodes.Text(' (')

            # NOTE: using .pop() here to prevent a single type node to be

            # inserted twice into the doctree, which leads to

            # inconsistencies later when references are resolved

            fieldtype = types.pop(fieldarg)

            if len(fieldtype) == 1 and isinstance(fieldtype[0], nodes.Text):

                typename = u''.join(n.astext() for n in fieldtype)

                typename = typename.replace('int', 'python:int')

                typename = typename.replace('long', 'python:long')

                typename = typename.replace('float', 'python:float')

                typename = typename.replace('type', 'python:type')

                par.extend(self.make_xrefs(self.typerolename, domain, typename,

                                           addnodes.literal_emphasis, **kw))

            else:

                par += fieldtype

            par += nodes.Text(')')

        par += nodes.Text(' -- ')

        par += content

        return par

    fieldname = nodes.field_name('', self.label)

    if len(items) == 1 and self.can_collapse:

        fieldarg, content = items[0]

        bodynode = handle_item(fieldarg, content)

    else:

        bodynode = self.list_type()

        for fieldarg, content in items:

            bodynode += nodes.list_item('', handle_item(fieldarg, content))

    fieldbody = nodes.field_body('', bodynode)

    return nodes.field('', fieldname, fieldbody)

TypedField.make_field = patched_make_field