-
Notifications
You must be signed in to change notification settings - Fork 1
/
mkdocs.yml
111 lines (106 loc) · 3.32 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
site_name: Research Project Template
site_description: Template for a ML Research project.
site_url: https://mila-iqia.github.io/ResearchTemplate/
repo_url: https://www.github.com/mila-iqia/ResearchTemplate
# edit_uri: edit/master/docs
theme:
name: material
features:
- navigation.instant
- navigation.instant.prefetch
- navigation.instant.preview
- content.code.copy
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to system preference
markdown_extensions:
- toc:
permalink: "#"
toc_depth: 3
- pymdownx.highlight: # https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#configuration
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.magiclink
- attr_list
- md_in_html
- admonition
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
plugins:
- search
- awesome-pages
- macros: #https://mkdocs-macros-plugin.readthedocs.io/en/latest/#declaration-of-the-macros-plugin
module_name: docs/macros
- autorefs
- gen-files:
# https://oprypin.github.io/mkdocs-gen-files/#usage
scripts:
- docs/generate_reference_docs.py
- literate-nav:
nav_file: SUMMARY.md
- section-index
- mkdocstrings:
handlers:
python:
import:
- https://docs.python-requests.org/en/master/objects.inv
- https://omegaconf.readthedocs.io/en/latest/objects.inv
- https://lightning.ai/docs/pytorch/stable/objects.inv
- https://docs.pytest.org/en/stable/objects.inv
- https://flax.readthedocs.io/en/latest/objects.inv
options:
docstring_style: google
members_order: source
annotations_path: brief
show_docstring_attributes: true
modernize_annotations: true
show_source: false
show_submodules: false
separate_signature: true
signature_crossrefs: true
show_signature_annotations: true
allow_inspection: true
- mkdocs-video:
is_video: True
video_muted: True
video_controls: True
css_style:
width: "100%"
# todo: take a look at https://github.com/drivendataorg/cookiecutter-data-science/blob/master/docs/mkdocs.yml
# - admonition
# - pymdownx.details
# - pymdownx.superfences
# - pymdownx.tabbed:
# alternate_style: true
# slugify: !!python/object/apply:pymdownx.slugs.slugify
# kwds:
# case: lower
# - tables
# - toc:
# toc_depth: 2