forked from pynapple-org/pynapple
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
59 lines (51 loc) · 1.58 KB
/
mkdocs.yml
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
site_name: pynapple
repo_url: https://github.com/pynapple-org/pynapple
theme:
name: 'material'
palette:
primary: 'green'
features:
- navigation.tabs
plugins:
- search
- gallery:
examples_dirs: docs/examples
gallery_dirs: docs/generated/gallery
conf_script: docs/gallery_conf.py
- gen-files:
scripts:
- docs/gen_ref_pages.py # Specify the script to generate the code reference pages
- literate-nav:
nav_file: docs/SUMMARY.md # Specify the navigation file for literate-style navigation
- section-index # Enable the section-index plugin for generating a section index
- mkdocstrings:
handlers:
python:
options:
docstring_style: numpy
show_source: true
members_order: source
inherited_members: true
show_root_heading: true
separate_signature: true
nav:
- Overview: index.md
- Usage: generated/gallery
- Modules : reference/
- Contributing: CONTRIBUTING.md
- Authors: AUTHORS.md
- History: HISTORY.md
extra_javascript:
- javascripts/katex.js
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js
extra_css:
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences