forked from pypa/hatch
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
174 lines (169 loc) · 4.59 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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
site_name: Hatch
site_description: Modern, extensible Python project management
site_author: Ofek Lev
site_url: https://hatch.pypa.io/latest/
repo_name: pypa/hatch
repo_url: https://github.com/pypa/hatch
edit_uri: blob/master/docs
copyright: 'Copyright © Ofek Lev 2017-present'
docs_dir: docs
site_dir: site
theme:
name: material
language: en
favicon: assets/images/favicon.ico
icon:
repo: fontawesome/brands/github-alt
# best approximation of an egg hatching
logo: material/egg-easter
font:
text: Roboto
code: Roboto Mono
palette:
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: indigo
accent: indigo
toggle:
icon: material/weather-night
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/weather-sunny
name: Switch to dark mode
features:
- navigation.sections
- navigation.tabs
- navigation.instant
nav:
- Home:
- About: index.md
- Installation: install.md
- Introduction: intro.md
- Environments: environment.md
- Versioning: version.md
- Builds: build.md
- Publishing: publish.md
- Next steps: next-steps.md
- Status:
- History: history.md
- Users: users.md
- Configuration:
- Metadata: config/metadata.md
- Dependencies: config/dependency.md
- Build: config/build.md
- Environments: config/environment.md
- Context formatting: config/context.md
- Project templates: config/project-templates.md
- Hatch: config/hatch.md
- CLI:
- About: cli/about.md
- Reference: cli/reference.md
- Plugins:
- About: plugins/about.md
- Builder: plugins/builder.md
- Build hook: plugins/build-hook.md
- Metadata hook: plugins/metadata-hook.md
- Environment: plugins/environment.md
- Environment collector: plugins/environment-collector.md
- Publisher: plugins/publisher.md
- Version source: plugins/version-source.md
- Version scheme: plugins/version-scheme.md
- Utilities: plugins/utilities.md
- Meta:
- FAQ: meta/faq.md
- Authors: meta/authors.md
plugins:
# Built-in
- search:
# Extra
- minify:
minify_html: true
- git-revision-date-localized:
type: date
- mike:
- mkdocstrings:
default_handler: python
handlers:
python:
rendering:
show_if_no_docstring: true
show_root_heading: true
show_root_full_path: false
show_signature_annotations: true
show_source: true
watch:
- backend/src/hatchling
- src/hatch
markdown_extensions:
# Built-in
- markdown.extensions.abbr:
- markdown.extensions.admonition:
- markdown.extensions.attr_list:
- markdown.extensions.footnotes:
- markdown.extensions.meta:
- markdown.extensions.tables:
- markdown.extensions.toc:
permalink: true
# Extra
- mkdocs-click:
- mkpatcher:
location: docs/.scripts
- pymdownx.arithmatex:
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret:
- pymdownx.critic:
- pymdownx.details:
- pymdownx.emoji:
# https://github.com/twitter/twemoji
# https://raw.githubusercontent.com/facelessuser/pymdown-extensions/master/pymdownx/twemoji_db.py
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight:
guess_lang: false
linenums_style: pymdownx-inline
use_pygments: true
- pymdownx.inlinehilite:
- pymdownx.keys:
- pymdownx.magiclink:
repo_url_shortener: true
repo_url_shorthand: true
social_url_shortener: true
social_url_shorthand: true
normalize_issue_symbols: true
provider: github
user: pypa
repo: hatch
- pymdownx.mark:
- pymdownx.progressbar:
- pymdownx.saneheaders:
- pymdownx.smartsymbols:
- pymdownx.snippets:
check_paths: true
base_path:
- docs/.snippets
- pymdownx.superfences:
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde:
extra:
version:
provider: mike
social:
- icon: fontawesome/brands/github-alt
link: https://github.com/ofek
- icon: fontawesome/solid/blog
link: https://ofek.dev/words/
- icon: fontawesome/brands/twitter
link: https://twitter.com/Ofekmeister
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/in/ofeklev/
extra_css:
- assets/css/custom.css
- https://cdn.jsdelivr.net/gh/tonsky/[email protected]/distr/fira_code.css