-
Notifications
You must be signed in to change notification settings - Fork 2
/
mkdocs.yml
92 lines (80 loc) · 2.03 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
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
site_name: gpyrn
repo_url: https://github.com/iastro-pt/gpyrn/
edit_uri: ""
theme:
name: "material"
features:
- navigation.instant
- navigation.tracking
# - navigation.sections
- navigation.expand
- navigation.indexes
palette:
- scheme: default
toggle:
icon: material/weather-night
name: Switch to dark mode
- scheme: slate
toggle:
icon: material/weather-sunny
name: Switch to light mode
nav:
- Welcome: 'index.md'
- Installation: 'installation.md'
- Getting started: 'getting_started.md'
- Examples:
- examples/index.md
- One dataset: 'examples/one_dataset.md'
- Several datasets: 'examples/several_datasets.md'
- 'benchmarks.md'
- Reference:
- meanfunc: 'reference/meanfunc.md'
- covfunc: 'reference/covfunc.md'
- 'Issue Tracker': 'https://github.com/iastro-pt/gpyrn/issues'
copyright: Copyright © 2021 - 2022 Institute of Astrophysics and Space Sciences
# extra:
# generator: false
plugins:
- search
- mkdocstrings
- mkdocstrings:
default_handler: python
handlers:
python:
rendering:
members_order: source
show_source: false
watch:
- gpyrn
custom_templates: templates
markdown_extensions:
- admonition
- pymdownx.details
- footnotes
- md_in_html
- pymdownx.caret
- pymdownx.mark
- pymdownx.tilde
- pymdownx.keys
- pymdownx.critic:
mode: view
- pymdownx.tabbed:
alternate_style: true
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.superfences
- pymdownx.arithmatex:
generic: true
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
options:
custom_icons:
- docs/overrides/.icons
extra_javascript:
- /docs/javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
# extra:
# version:
# provider: mike