Diff of /docs/conf.py [000000] .. [5d6472]

Switch to unified view

a b/docs/conf.py
1
import os
2
import sys
3
import logging
4
from datetime import datetime
5
from pathlib import Path
6
from sphinx.ext import autosummary
7
8
import matplotlib
9
matplotlib.use('agg')
10
11
HERE = Path(__file__).parent
12
sys.path.insert(0, str(HERE.parent))
13
14
import multivelo
15
16
# -- Project information
17
18
project = 'MultiVelo'
19
copyright = f'{datetime.now():%Y}, Welch Lab'
20
author = 'Chen Li'
21
22
release = '0.1'
23
version = '0.1.5'
24
25
notebooks_url = "https://github.com/welch-lab/multivelo/raw/main/multivelo_demo/MultiVelo_Demo.ipynb"
26
27
# -- General configuration
28
29
extensions = [
30
    'sphinx.ext.doctest',
31
    'sphinx.ext.autodoc',
32
    'sphinx.ext.autosummary',
33
    'sphinx.ext.intersphinx',
34
    'sphinx.ext.napoleon',
35
    'sphinx.ext.githubpages',
36
    'nbsphinx',
37
    'nbsphinx_link'
38
]
39
40
autosummary_generate = True
41
# Napoleon settings
42
napoleon_google_docstring = False
43
napoleon_numpy_docstring = True
44
napoleon_include_init_with_doc = False
45
napoleon_include_private_with_doc = False
46
napoleon_include_special_with_doc = True
47
napoleon_use_admonition_for_examples = False
48
napoleon_use_admonition_for_notes = False
49
napoleon_use_admonition_for_references = False
50
napoleon_use_ivar = False
51
napoleon_use_param = True
52
napoleon_use_rtype = False
53
napoleon_preprocess_types = False
54
napoleon_type_aliases = None
55
napoleon_attr_annotations = True
56
57
html_theme = "sphinx_rtd_theme"
58
html_static_path = ['_static']
59
html_css_files = [
60
    'custom.css',
61
]
62
63
intersphinx_mapping = {
64
    'python': ('https://docs.python.org/3/', None),
65
    'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
66
}
67
intersphinx_disabled_domains = ['std']
68
69
templates_path = ['_templates']
70
71
# -- Options for HTML output
72
73
html_theme = 'sphinx_rtd_theme'
74
75
# -- Options for EPUB output
76
epub_show_urls = 'footnote'
77
78
suppress_warnings = ["config.cache"]