-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
132 lines (124 loc) · 3.49 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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
site_name: "neuralfields"
site_author: "Fabio Muratore"
site_description: "A type of potential-based recurrent neural networks implemented with PyTorch"
site_dir: .site
site_url: "https://famura.github.io/neuralfields"
repo_name: "famura/neuralfields"
repo_url: "https://github.com/famura/neuralfields"
edit_uri: "blob/main/docs"
nav:
- Overview:
- Overview: index.md
- Getting Started: getting_started.md
- Changelog: exported/changelog.md
- Code Reference: reference/
- Development:
- Contributing: contributing.md
- Coverage: exported/coverage/report.html
- Tests: exported/tests/report.html
- License:
- This Project: license.md
- Third-Party Libraries: exported/third_party_licenses.md
theme:
name: material
features:
- header.autohide
- navigation.indexes
- navigation.instant
- navigation.tabs
- navigation.top
- search.highlight
- search.suggest
- toc.follow
# font: false # Disabled because of GDPR, see https://squidfunk.github.io/mkdocs-material/setup/changing-the-fonts/#autoloading
icon:
repo: fontawesome/brands/github
palette:
- scheme: default
accent: indigo
media: "(prefers-color-scheme: light)"
primary: indigo
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
accent: deep orange
media: "(prefers-color-scheme: dark)"
primary: deep orange
toggle:
icon: material/brightness-4
name: Switch to light mode
markdown_extensions:
# Python Markdown
- abbr
- admonition
- attr_list
- def_list
- footnotes
- meta
- md_in_html
- toc:
permalink: true
# Python Markdown Extensions
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.snippets:
check_paths: true
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
plugins:
- gen-files:
scripts:
- docs/generate_code_reference.py
- git-revision-date-localized:
fallback_to_build_date: true
- literate-nav:
nav_file: code_nav.md
- minify:
minify_html: true
- mkdocstrings:
# https://mkdocstrings.github.io/usage/#cross-references-to-other-projects-inventories
enable_inventory: true
handlers:
python:
import:
- https://docs.python.org/3/objects.inv
- https://pytorch.org/docs/stable/objects.inv
options:
show_source: true
inherited_members: true
docstring_style: google
docstring_options:
ignore_init_summary: true
merge_init_into_class: true
- search
extra:
generator: false
version:
provider: mike
extra_css:
- stylesheets/extra.css
extra_javascript:
# Sortable tables (see https://squidfunk.github.io/mkdocs-material/reference/data-tables)
- https://unpkg.com/tablesort/dist/tablesort.min.js
- js/tablesort.js
# MathJax (see https://squidfunk.github.io/mkdocs-material/reference/mathjax)
- javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js