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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
|
site_name: sparse
repo_url: https://github.com/pydata/sparse.git
edit_uri: edit/main/docs/
#use_directory_urls: false
theme:
name: material
palette:
primary: custom
accent: cyan
font: false #avoid Google Fonts to adhere to data privacy regulations
logo: assets/images/logo.png
favicon: assets/images/logo.svg
features:
- navigation.tabs
- navigation.tabs.sticky
- navigation.tracking
- navigation.instant
- navigation.instant.progress
- navigation.prune
- navigation.footer
- navigation.indexes
- navigation.expand
- navigation.top # adds a back-to-top button when user scrolls up
- content.code.copy
markdown_extensions:
- tables
- admonition # This line, pymdownx.details and pymdownx.superfences are used by warings
- pymdownx.details
- pymdownx.superfences
- codehilite
- toc:
toc_depth: 3
- pymdownx.arithmatex: # To display math content with KaTex
generic: true
- attr_list # To be able to link to a header on another page, use grids
- md_in_html # Used for grids
extra_javascript:
- js/katex.js
- https://unpkg.com/katex@0/dist/katex.min.js
- https://unpkg.com/katex@0/dist/contrib/auto-render.min.js
extra_css:
- https://unpkg.com/katex@0/dist/katex.min.css
- css/mkdocstrings.css
plugins:
- search
- section-index
- autorefs
- gen-files:
scripts:
- scripts/gen_ref_pages.py
- literate-nav
- mkdocstrings:
handlers:
python:
import:
- https://numpy.org/doc/stable/objects.inv
- https://docs.python.org/3/objects.inv
- https://docs.scipy.org/doc/scipy/objects.inv
options:
inherited_members: yes
show_root_members_full_path: false
show_if_no_docstring: true
members_order: source
docstring_style: numpy
show_source: true
filters: ["!^_"]
group_by_category: true
show_category_heading: true
- mkdocs-jupyter:
include_source: true
execute: true
ignore: ["__init__.py", "utils.py", "gen_logo.py"]
nav:
- Home:
- index.md
- Introduction:
- introduction.md
- Install:
- install.md
- Tutorials:
- examples.md
- examples/*
- How to guides:
- how-to-guides.md
- quickstart.md
- construct.md
- operations.md
- API:
- api.md
- api/*
- Contributing:
- contributing.md
- roadmap.md
- completed-tasks.md
- changelog.md
- conduct.md
|
