sinabs/docs/conf.py at develop · mrontio/sinabs · GitHub

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
import sinabs

project = "Sinabs"
copyright = "2019-present, SynSense"
author = "employees of SynSense"

master_doc = "index"

extensions = [
    "myst_nb",
    "pbr.sphinxext",
    "sphinx.ext.autodoc",
    "sphinx.ext.mathjax",
    "sphinx.ext.napoleon",
    "sphinx.ext.autosummary",
    "sphinx.ext.viewcode",
    "sphinx.ext.graphviz",
    "sphinx_gallery.gen_gallery",
]

myst_enable_extensions = [
    "dollarmath",
    "amsmath",
]

autodoc_typehints = "both"

sphinx_gallery_conf = {
    "examples_dirs": "gallery/",  # path to your example scripts
    "gallery_dirs": "auto_examples",  # path to where to save gallery generated output
    # "backreferences_dir": "gen_modules/backreferences",
    "doc_module": ("sinabs",),
    "download_all_examples": False,
    "ignore_pattern": r"utils\.py",
}

# Napoleon settings
napoleon_google_docstring = True
napoleon_numpy_docstring = True

# MyST settings
suppress_warnings = ["myst.header"]
nb_execution_timeout = 300
nb_execution_excludepatterns = [
    "LeNet_5_EngChinese.ipynb",
    "bptt.ipynb",
    "weight_transfer_mnist.ipynb",
    "synops_loss_ann.ipynb",
    "nmnist.ipynb",
    "nmnist_quick_start.ipynb",
    "leak_neuron.ipynb",
    "nir_to_speck.ipynb",
    "visualize_speck_dvs_input.ipynb",
    "power_monitoring.ipynb",
    "visualize_spike_count.ipynb",
    "using_readout_layer.ipynb",
]
# nb_execution_mode = "off"

templates_path = ["_templates"]

exclude_patterns = ["_build", "**.ipynb_checkpoints"]

html_title = sinabs.__version__
html_theme = "sphinx_book_theme"
html_logo = "_static/sinabs-logo-lowercase-whitebg.png"
html_show_sourcelink = True
html_sourcelink_suffix = ""

html_static_path = ["_static"]

html_theme_options = {
    "repository_url": "https://github.com/synsense/sinabs",
    "use_repository_button": True,
    "use_issues_button": True,
    "use_edit_page_button": True,
    "repository_branch": "develop",
    "path_to_docs": "docs",
    "use_fullscreen_button": True,
}