|
a |
|
b/docs/conf.py |
|
|
1 |
import os |
|
|
2 |
import sys |
|
|
3 |
|
|
|
4 |
from sphinx.highlighting import lexers |
|
|
5 |
|
|
|
6 |
sys.path.insert(0, os.path.abspath("..")) |
|
|
7 |
sys.path.insert(0, os.path.abspath(".")) |
|
|
8 |
|
|
|
9 |
import scvae |
|
|
10 |
from custom_lexers import TerminalLexer |
|
|
11 |
|
|
|
12 |
# Project information |
|
|
13 |
|
|
|
14 |
project = scvae.__title__ |
|
|
15 |
copyright = scvae.__copyright__ |
|
|
16 |
author = scvae.__author__ |
|
|
17 |
version = scvae.__version__ |
|
|
18 |
release = scvae.__version__ |
|
|
19 |
|
|
|
20 |
# General configuration |
|
|
21 |
|
|
|
22 |
extensions = [ |
|
|
23 |
"sphinx.ext.autodoc", |
|
|
24 |
"sphinx.ext.autosectionlabel", |
|
|
25 |
"sphinx.ext.napoleon" |
|
|
26 |
] |
|
|
27 |
templates_path = ["_templates"] |
|
|
28 |
source_suffix = { |
|
|
29 |
".rst": "restructuredtext" |
|
|
30 |
} |
|
|
31 |
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
|
|
32 |
default_role = "py:obj" |
|
|
33 |
|
|
|
34 |
# autodoc options |
|
|
35 |
|
|
|
36 |
autodoc_member_order = "bysource" |
|
|
37 |
autodoc_mock_imports = [ |
|
|
38 |
"loompy", |
|
|
39 |
"matplotlib", |
|
|
40 |
"mpl_toolkits", |
|
|
41 |
"pandas", |
|
|
42 |
"PIL", |
|
|
43 |
"sklearn", |
|
|
44 |
"scipy", |
|
|
45 |
"seaborn", |
|
|
46 |
"tables", |
|
|
47 |
"tensorflow", |
|
|
48 |
"tensorflow_probability" |
|
|
49 |
] |
|
|
50 |
|
|
|
51 |
# HTML options |
|
|
52 |
|
|
|
53 |
html_theme = "alabaster" |
|
|
54 |
html_static_path = ["_static"] |
|
|
55 |
html_theme_options = { |
|
|
56 |
"github_user": "scvae", |
|
|
57 |
"github_repo": "scvae", |
|
|
58 |
"github_type": "star", |
|
|
59 |
"description": "Single-cell variational auto-encoders", |
|
|
60 |
"show_powered_by": False |
|
|
61 |
} |
|
|
62 |
html_sidebars = { |
|
|
63 |
"**": [ |
|
|
64 |
"about.html", |
|
|
65 |
"navigation.html", |
|
|
66 |
"searchbox.html", |
|
|
67 |
] |
|
|
68 |
} |
|
|
69 |
|
|
|
70 |
lexers["terminal"] = TerminalLexer(startinline=True) |