-
Notifications
You must be signed in to change notification settings - Fork 4
/
mkdocs.yml
64 lines (56 loc) · 1.34 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
60
61
62
63
64
site_name: pyAVL Docs
## Repository
repo_name: pyavl
repo_url: https://github.com/joanibal/pyAVL
edit_uri: https://github.com/joanibal/pyAVL/edit/master/docs
nav:
- Home: index.md
- Installation:
- installation.md
- Usage:
- usage.md
- analysis.md
- parameter_sweeps.md
- optimization.md
# defer to gen-files + literate-nav
- Code Reference: reference/
watch:
- pyavl
theme:
name: material
## Plugins
plugins:
- search:
# This mess was copied from the example website
separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
- gen-files:
scripts:
- docs/gen_ref_pages.py #
- mkdocstrings:
handlers:
python:
options:
show_source: false
- literate-nav:
nav_file: SUMMARY.md
markdown_extensions:
- attr_list
- admonition
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.tabbed:
alternate_style: true
- toc:
permalink: true
toc_depth: 1-3
- pymdownx.arithmatex:
generic: true
extra_javascript:
- javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js