import datetime

extensions = [
    'ase.utils.sphinx',
    'sphinx.ext.autodoc',
    'sphinx.ext.doctest',
    'sphinx.ext.extlinks',
    'sphinx.ext.mathjax',
    'sphinx.ext.viewcode',
    'sphinx.ext.napoleon',
    'sphinx.ext.intersphinx',
    'sphinx.ext.imgconverter',
    'sphinx_gallery.gen_gallery',
]

extlinks = {
    'doi': ('https://doi.org/%s', 'doi: %s'),
    'arxiv': ('https://arxiv.org/abs/%s', 'arXiv: %s'),
    'mr': ('https://gitlab.com/ase/ase/-/merge_requests/%s', 'MR: !%s'),
    'issue': ('https://gitlab.com/ase/ase/-/issues/%s', 'issue: #%s'),
}
source_suffix = '.rst'
master_doc = 'index'
project = 'ASE'
author = 'ASE developers'
copyright = f'{datetime.date.today().year}, ASE-developers'
exclude_patterns = ['build']
default_role = 'math'
pygments_style = 'sphinx'
autoclass_content = 'both'
modindex_common_prefix = ['ase.']
nitpick_ignore = [
    ('envvar', 'VASP_PP_PATH'),
    ('envvar', 'VASP_PP_VERSION'),
    ('envvar', 'ASE_ABC_COMMAND'),
    ('envvar', 'LAMMPS_COMMAND'),
    ('envvar', 'ASE_NWCHEM_COMMAND'),
    ('envvar', 'SIESTA_COMMAND'),
    ('envvar', 'SIESTA_PP_PATH'),
    ('envvar', 'VASP_SCRIPT'),
]
sphinx_gallery_conf = {
    'filename_pattern': r'/*\.py',
    # "copyfile_regex": r".*\.(xyz|dat)",
    'examples_dirs': ['../examples'],
    'gallery_dirs': ['examples_generated'],
    'min_reported_time': 60,
    'reference_url': {'ase': None},
    'remove_config_comments': True,
    'prefer_full_module': ['ase'],
    'matplotlib_animations': (True, 'mp4'),
    'within_subsection_order': 'FileNameSortKey',
}

html_theme = 'sphinx_book_theme'
html_logo = 'static/ase256.png'
html_favicon = 'static/ase.ico'
html_static_path = ['static']
html_last_updated_fmt = '%a, %d %b %Y %H:%M:%S'

html_theme_options = {
    # https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/header-links.html
    'gitlab_url': 'https://gitlab.com/ase/ase',
    # https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/indices.html
    'primary_sidebar_end': ['indices.html'],
}

latex_elements = {'papersize': 'a4paper'}
latex_show_urls = 'inline'
latex_show_pagerefs = True
latex_engine = 'xelatex'
latex_documents = [
    ('index', 'ASE.tex', 'ASE', 'ASE-developers', 'howto', not True)
]

intersphinx_mapping = {
    'gpaw': ('https://gpaw.readthedocs.io', None),
    'python': ('https://docs.python.org/3.10', None),
}

# Avoid GUI windows during doctest:
doctest_global_setup = """
import numpy as np
import ase.visualize as visualize
from ase import Atoms
visualize.view = lambda atoms: None
Atoms.edit = lambda self: None
"""

autodoc_mock_imports = ['kimpy']
