1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
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',
]
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', 'ASE_ABC_COMMAND'),
('envvar', 'LAMMPS_COMMAND'),
('envvar', 'ASE_NWCHEM_COMMAND'),
('envvar', 'SIESTA_COMMAND'),
('envvar', 'SIESTA_PP_PATH'),
('envvar', 'VASP_SCRIPT'),
]
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', ('/usr/share/doc/python3/html/objects.inv', 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']
|
