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
|
# Book settings
# Learn more at https://jupyterbook.org/customize/config.html
title: napari
author: The napari team
logo: images/logo.png
# only_build_toc_files: true
# Force re-execution of notebooks on each build.
# See https://jupyterbook.org/content/execute.html
execute:
execute_notebooks: force
# Information about where the book exists on the web
repository:
url: https://github.com/napari/napari # Online location of your book
path_to_book: docs # Optional path to your book, relative to the repository root
branch: main # Which branch of the repository should be used when creating links (optional)
# Exclude files from build (prevents Sphinx warnings about missing
# files in table of contents _toc.yml)
exclude_patterns: [
'ORGANIZATION.md',
'guides/_viewer_events.md',
'guides/_layer_events.md',
]
# Add GitHub buttons to your book
# See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository
html:
use_issues_button: true
use_repository_button: true
sphinx:
extra_extensions:
- sphinx.ext.intersphinx
- sphinx.ext.napoleon
- sphinx.ext.autodoc
- sphinx_tabs.tabs
config:
autosummary_generate: True
autosummary_imported_members: True
html_theme: furo
html_theme_options: {}
pygments_style: solarized-dark
suppress_warnings: ["myst.header"]
exclude_patterns: ['**/_*.md'] # includes
templates_path:
- '_templates'
intersphinx_mapping:
python:
- "https://docs.python.org/3"
- null
numpy:
- "https://numpy.org/doc/stable/"
- null
napari_plugin_engine:
- "https://napari-plugin-engine.readthedocs.io/en/latest/"
- "https://napari-plugin-engine.readthedocs.io/en/latest/objects.inv"
magicgui:
- "https://pyapp-kit.github.io/magicgui/"
- "https://pyapp-kit.github.io/magicgui/objects.inv"
napari:
- "https://napari.org/"
- "https://napari.org/docs/dev/objects.inv"
|
