-
Notifications
You must be signed in to change notification settings - Fork 2
/
mkdocs.yml
144 lines (143 loc) · 6.15 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
133
134
135
136
137
138
139
140
141
142
143
144
site_name: PatchScope Documentation
site_url: https://ncusi.github.io/PatchScope
repo_url: https://github.com/ncusi/PatchScope
repo_name: PatchScope
edit_uri: "" # turn off the feature
#strict: true
nav:
- home: index.md
#- installation: installation.md
#- usage: usage.md
#- modules: api.md
#- contributing: contributing.md
#- authors: authors.md
#- history: history.md
- CLI: cli.md
- API: reference/
- schema: schema.md
- examples: examples.md
- notebooks: notebooks.md
- web: diffinsights_web.md
theme:
name: material
language: en
logo: favicon.svg
#favicon: favicon.png
icon:
#repo: fontawesome/brands/git-alt # the default
repo: fontawesome/brands/github
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/weather-night
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/weather-sunny
name: Switch to light mode
features:
- navigation.indexes # documents can be directly attached to sections (for overview pages)
- navigation.instant # clicks on all internal links will be dispatched via XHR
- navigation.instant.progress # progress indicator on slow connections when using instant navigation
- navigation.tabs # top-level sections are rendered in a menu layer below the header
- navigation.tabs.sticky # navigation tabs will lock below the header and always remain visible
- navigation.top # add floating backt-to-top button
- navigation.tracking # automatically update URL with the active anchor
#- toc.follow # scroll sidebar so that the active anchor is always visible
#- search.suggest # enable search suggestions, can be accepted with 'Right' key
- header.autohide # hide header when the user scrolls past a certain threshold
- navigation.footer # links to the previous and next page of the current page
markdown_extensions:
#- pymdownx.emoji: # inserting emoji via simple short names, e.g. :thumbsup:
# emoji_index: !!python/name:materialx.emoji.twemoji # problems with materialx, ...
## ERROR: Could not find a version that satisfies the requirement mkdocs-material-extension~=1.0.3;
## extra == "doc" (from patchscope[dev,doc]) (from versions: none)
## ERROR: No matching distribution found for mkdocs-material-extension~=1.0.3; extra == "doc"
# emoji_generator: !!python/name:material.extensions.emoji.to_svg # problems with material.extensions
## Error: MkDocs encountered an error parsing the configuration file: while constructing a Python object
## cannot find module 'material.extensions.emoji' (No module named 'material.extensions')
## in "/home/runner/work/PatchScope/PatchScope/mkdocs.yml", line 36, column 20
#- pymdownx.critic # editorial change tracking in plain text files
- pymdownx.caret # ^^insert^^, text^superscript
#- pymdownx.mark # ==mark me==
- pymdownx.tilde # ~~delete~~, text~subscript
- pymdownx.tabbed # tabbed contents
- pymdownx.arithmatex: # block and inline block equations: $...$, $$...$$
generic: true
- pymdownx.highlight: # syntax highlighting of code blocks (with superfences)
linenums: false
- pymdownx.superfences: # arbitrary nesting of code and content blocks
preserve_tabs: true
custom_fences:
# Mermaid diagrams
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.details # make admonition call-outs collapsible
- pymdownx.tasklist: # GitHub Flavored Markdown inspired task lists
custom_checkbox: true # replace native checkbox styles with icons
- admonition # admonitions (or call-outs), !!! note "optional title"...
- attr_list # add HTML attributes and CSS classes to almost every element
- toc: # automatically generate a table of contents
baselevel: 2
permalink: true
slugify: !!python/name:pymdownx.slugs.uslugify
- meta
- mkdocs-typer # generate documentation for Typer command line applications
plugins:
- include-markdown # including (embedding) Markdown files, by default within {% and %}
- search: # adds a search bar to the header; powered by lunr.js
lang: en
# automatic generation of files for mkdocstrings
# see https://mkdocstrings.github.io/recipes/#automatic-code-reference-pages
- gen-files: # generate mkdocstrings pages on-the-fly
scripts:
- scripts/gen_ref_pages.py
- literate-nav: # generate a literate navigation file for mkdocstrings pages
nav_file: SUMMARY.md
# NOTE: section-index is turned off, because it interfered with adding API docs for diffannotator
#- section-index # bind pages to sections themselves in mkdocstrings pages
# generating documentation from docstrings, now automatically
- mkdocstrings: # automatic documentation from sources for MkDocs
default_handler: python
handlers:
python:
paths: [ "src" ]
show_bases: true
docstring_style: sphinx
#docstring_section_style: spacy
show_signature: true
separate_signature: true
show_signature_annotations: true
watch: # for `mkdocs serve`, to trigger rebuild
- src
#extra:
# version:
# provider: mike
# social:
# - icon: fontawesome/brands/twitter
# # replace with your own tweet link below
# link: http://www.jieyu.ai
# name: Tweet
# - icon: fontawesome/brands/facebook
# # replace with your own facebook link below
# link: http://www.jieyu.ai
# name: Facebook
# - icon: fontawesome/brands/github
# link: https://github.com/jnareb/python_project_wizard_demo
# name: Github
# - icon: material/email
# link: "mailto:[email protected]"
# # to enable disqus, uncomment the following and put your disqus id below
# # disqus: disqus_id
# uncomment the following and put your google tracking id below to enable GA
#google_analytics:
#- UA-xxx
#- auto
extra_javascript:
- assets/optionalConfig.js
- https://unpkg.com/[email protected]/dist/mermaid.min.js
# or https://cdn.jsdelivr.net/npm/[email protected]/dist/mermaid.min.js
- assets/extra-loader.js