-
Notifications
You must be signed in to change notification settings - Fork 92
/
conf.py
76 lines (66 loc) · 2.02 KB
/
conf.py
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
# -*- coding: utf-8 -*-
import pygsp
extensions = [
'sphinx.ext.viewcode',
'sphinx.ext.autosummary',
'sphinx.ext.mathjax',
'sphinx.ext.inheritance_diagram',
'sphinxcontrib.bibtex',
]
extensions.append('sphinx.ext.autodoc')
autodoc_default_flags = ['members', 'undoc-members']
autodoc_member_order = 'groupwise' # alphabetical, groupwise, bysource
extensions.append('sphinx.ext.intersphinx')
intersphinx_mapping = {
'pyunlocbox': ('https://pyunlocbox.readthedocs.io/en/stable', None),
'networkx': ('https://networkx.github.io/documentation/stable', None),
'graph_tool': ('https://graph-tool.skewed.de/static/doc', None),
'numpy': ('https://docs.scipy.org/doc/numpy', None),
'scipy': ('https://docs.scipy.org/doc/scipy/reference', None),
'matplotlib': ('https://matplotlib.org', None),
}
extensions.append('numpydoc')
numpydoc_show_class_members = False
numpydoc_use_plots = True # Add the plot directive whenever mpl is imported.
extensions.append('matplotlib.sphinxext.plot_directive')
plot_include_source = True
plot_html_show_source_link = False
plot_html_show_formats = False
plot_working_directory = '.'
plot_rcparams = {
'figure.figsize': (10, 4)
}
plot_pre_code = """
import numpy as np
from pygsp import graphs, filters, utils, plotting
"""
extensions.append('sphinx_gallery.gen_gallery')
sphinx_gallery_conf = {
'examples_dirs': '../examples',
'gallery_dirs': 'examples',
'filename_pattern': '/',
'reference_url': {'pygsp': None},
'backreferences_dir': 'backrefs',
'doc_module': 'pygsp',
'show_memory': True,
}
exclude_patterns = ['_build']
source_suffix = '.rst'
master_doc = 'index'
project = 'PyGSP'
version = pygsp.__version__
release = pygsp.__version__
copyright = 'EPFL LTS2'
pygments_style = 'sphinx'
html_theme = 'sphinx_rtd_theme'
html_theme_options = {
'navigation_depth': 2,
}
latex_elements = {
'papersize': 'a4paper',
'pointsize': '10pt',
}
latex_documents = [
('index', 'pygsp.tex', 'PyGSP documentation',
'EPFL LTS2', 'manual'),
]