-
Notifications
You must be signed in to change notification settings - Fork 23
Expand file tree
/
Copy pathconf.py
More file actions
123 lines (101 loc) · 2.61 KB
/
conf.py
File metadata and controls
123 lines (101 loc) · 2.61 KB
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# Configuration file for the Sphinx documentation builder.
# -- Project information
import sys
import os
import subprocess
import memilio
project = 'MEmilio'
copyright = '2020-2026 MEmilio'
author = ''
release = ''
version = '1.3.0'
read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
if read_the_docs_build:
subprocess.call('git submodule update --init --recursive', shell=True)
subprocess.call('cd ..; doxygen', shell=True)
subprocess.call('cd ..; doxysphinx build source $READTHEDOCS_OUTPUT/html Doxyfile', shell = True)
# sys.path.insert(0, os.path.abspath('../../pycode'))
# -- General configuration
extensions = [
'sphinx.ext.duration',
'sphinx.ext.doctest',
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.intersphinx',
'sphinx.ext.napoleon',
'sphinx_copybutton',
'sphinx_toolbox.collapse',
'sphinx_design',
'hoverxref.extension',
'sphinxcontrib.doxylink',
# 'sphinx_remove_toctrees'
]
intersphinx_mapping = {
'python': ('https://docs.python.org/3/', None),
'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
}
intersphinx_disabled_domains = ['std']
templates_path = ['_templates']
hoverxref_auto_ref = True
hoverxref_roles = ["term"]
hoverxref_domains = ["py"]
hoverxref_role_types = {
"hoverxref": "tooltip",
"ref": "tooltip",
"term": "tooltip",
"obj": "tooltip",
"func": "tooltip",
"mod": "tooltip",
"meth": "tooltip",
"class": "tooltip",
}
# doxylink readthedocs setup:
doxylink = {
"CPP-API": ("cppapi/html/tagfile.xml",
"cppapi/html")
}
#doxylink local setup:
# doxylink = {
# "CPP-API": ("source/cppapi/html/tagfile.xml",
# "../../source/cppapi/html")
# }
# remove_from_toctrees = ["api/*"]
templates_path = ['_templates']
# -- Options for HTML output
html_static_path = ['_static']
html_css_files = [
'custom.css',
]
html_favicon = "../memilio.ico"
maximum_signature_line_length = 40
html_theme = 'sphinx_rtd_theme'
html_logo = "../memilio-small.png"
html_theme_options = {
"collapse_navigation": True,
"logo_only": True,
"style_nav_header_background": "#f8f9fb",
}
# Mock heavy dependencies to speed up build
autodoc_mock_imports = [
"numpy",
"scipy",
"pandas",
"matplotlib",
"tensorflow",
"scikit-learn",
"h5py",
"tables",
"geopandas",
"pyarrow",
"PyQt6",
"wget",
"twill",
"folium",
"mapclassify",
"imageio",
# Mock C++ extension modules that require compilation
"memilio.simulation",
"memilio.generation",
]
# -- Options for EPUB output
epub_show_urls = 'footnote'