-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
executable file
·156 lines (145 loc) · 3.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
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
145
146
147
148
149
150
151
152
153
154
155
156
# Project Documentation Rules and Instructions
# Project Information
site_name: miller
site_description:
site_url: https://WithPrecedent.github.io/miller
repo_name: WithPrecedent/miller
repo_url: https://github.com/WithPrecedent/miller
watch: [
mkdocs.yml,
README.md,
CONTRIBUTING.md,
CHANGELOG.md,
src/miller]
copyright: Copyright, 2023 Corey Rayburn Yung
docs_dir: docs
# Documentation Structure
nav:
- Home:
- Overview: index.md
- Changelog: changelog.md
- Credits: credits.md
- License: license.md
- User Guide:
- Tutorial: tutorial.md
- Advanced User Guide: advanced.md
- Recipes: recipes.md
- API: reference/
- Development:
- Contributing: contributing.md
- Code of Conduct: code_of_conduct.md
# - Coverage Report: coverage.md
# Documentation Appearance
theme:
name: material
locale: en
icon:
repo: fontawesome/brands/github
features:
- announce.dismiss
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
- content.tabs.link
- content.tooltips
- navigation.footer
- navigation.indexes
- navigation.path
- navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.suggest
- toc.follow
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: teal
accent: purple
toggle:
icon: material/weather-sunny
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: lime
toggle:
icon: material/weather-night
name: Switch to system preference
# Extras, Extensions, and Plugins
extra_css:
- css/material.css
- css/mkdocstrings.css
markdown_extensions:
- attr_list
- admonition
- callouts
- footnotes
- md_in_html
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.snippets:
check_paths: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- sane_lists
- tables
- toc:
permalink: true
plugins:
- autorefs
# - coverage:
# page_name: coverage
# html_report_dir: htmlcov
- gen-files:
scripts:
- docs/scripts/gen_ref_nav.py
- literate-nav:
nav_file: SUMMARY.md
- markdown-exec:
- minify:
minify_html: !ENV [DEPLOY, false]
- mkdocstrings:
handlers:
python:
import:
- https://docs.python.org/3/objects.inv
options:
docstring_section_style: table
filters:
- "!^__"
heading_level: 1
# members_order: alphabetical
merge_init_into_class: true
separate_signature: false
show_signature_annotations: false
- search:
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/WithPrecedent
- icon: fontawesome/brands/python
link: https://pypi.org/project/miller/