conf.py 1.4 KB
Newer Older
Gao, Xiang's avatar
Gao, Xiang committed
1
2
3
4
5
6
7
import torchani  # noqa: F401
import sphinx_rtd_theme

project = 'TorchANI'
copyright = '2018, Roitberg Group'
author = 'Xiang Gao'

Gao, Xiang's avatar
Gao, Xiang committed
8
9
version = torchani.__version__
release = torchani.__version__
Gao, Xiang's avatar
Gao, Xiang committed
10
11
12
13
14
15
16

extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.napoleon',
    'sphinx.ext.intersphinx',
    'sphinx.ext.mathjax',
    'sphinx.ext.viewcode',
Gao, Xiang's avatar
Gao, Xiang committed
17
    'sphinx_gallery.gen_gallery',
Gao, Xiang's avatar
Gao, Xiang committed
18
19
20
21
22
23
24
25
26
27
28
29
]

templates_path = ['_templates']
html_static_path = ['_static']

source_suffix = '.rst'
master_doc = 'index'
pygments_style = 'sphinx'
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
htmlhelp_basename = 'TorchANIdoc'

Gao, Xiang's avatar
Gao, Xiang committed
30
31
32
33
34
35
sphinx_gallery_conf = {
     'examples_dirs': '../examples',
     'gallery_dirs': 'examples',
     'filename_pattern': r'.*\.py'
}

Gao, Xiang's avatar
Gao, Xiang committed
36
37
38
39
40
intersphinx_mapping = {
    'python': ('https://docs.python.org/', None),
    'numpy': ('http://docs.scipy.org/doc/numpy/', None),
    'torch': ('https://pytorch.org/docs/master/', None),
    'ignite': ('https://pytorch.org/ignite/', None),
Gao, Xiang's avatar
Gao, Xiang committed
41
    'ase': ('https://wiki.fysik.dtu.dk/ase/', None),
Gao, Xiang's avatar
Gao, Xiang committed
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
}

latex_documents = [
    (master_doc, 'TorchANI.tex', 'TorchANI Documentation',
     'Xiang Gao', 'manual'),
]

man_pages = [
    (master_doc, 'torchani', 'TorchANI Documentation',
     [author], 1)
]

texinfo_documents = [
    (master_doc, 'TorchANI', 'TorchANI Documentation',
     author, 'TorchANI', 'One line description of project.',
     'Miscellaneous'),
]