-
Notifications
You must be signed in to change notification settings - Fork 3
/
mkdocs.yml
194 lines (185 loc) · 5.72 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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
site_name: pydev-guide
repo_url: https://github.com/pydev-guide/pydev-guide.github.io
repo_name: pydev-guide
edit_uri: edit/main/docs/
nav:
- Home: index.md
- Quickstart: quickstart.md
- Tutorial:
- tutorial/index.md
- tutorial/summary.md
- tutorial/bare_minimum.md
- Pre-requisite:
- tutorial/pre_requisite/virtual_environment.md
- tutorial/pre_requisite/version_control.md
- tutorial/pre_requisite/ide.md
- Writing code:
- tutorial/writing_code/writing_code.md
- tutorial/writing_code/pep8.md
- tutorial/writing_code/code_documentation.md
- tutorial/writing_code/typing.md
- tutorial/writing_code/project_metadata.md
- Testing:
- tutorial/testing/testing.md
- tutorial/testing/code_to_be_tested.md
- tutorial/testing/using_pytest.md
- tutorial/testing/real_tests.md
- tutorial/testing/test_with_parameters.md
- tutorial/testing/test_for_errors.md
- tutorial/testing/test_fixtures.md
- tutorial/testing/test_coverage.md
- tutorial/testing/test_conclusion.md
- Code quality:
- tutorial/code_quality/code_quality.md
- tutorial/code_quality/pre_commit_hooks.md
- tutorial/code_quality/linter.md
- tutorial/code_quality/formatter.md
- tutorial/code_quality/type_checking.md
- Github:
- tutorial/github/github.md
- tutorial/github/continuous_integration.md
- tutorial/github/github_apps.md
- tutorial/github/deployment.md
- tutorial/github/publishing.md
- tutorial/github/github_pages.md
- Guides:
- guides/index.md
- pyproject.toml: guides/pyproject.md
- Packaging: guides/packaging.md
- Typing: guides/typing.md
- Linters: guides/linters.md
- IDEs: guides/ides.md
- Formatters: guides/formatters.md
- Testing: guides/testing.md
- Version Management: guides/versioning.md
- Publishing: guides/publishing.md
- Continuous Integration: guides/ci.md
- Documentation: guides/documentation.md
- Pre-commit: guides/pre-commit.md
- Dependency Management: guides/dependencies.md
- Glossary: glossary.md
# - "[md demo]": demo.md
theme:
name: material
logo: img/flask_logo.svg
favicon: img/flask_logo.svg
font: false
custom_dir: docs/.overrides
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: white
accent: indigo
toggle:
icon: octicons/moon-24
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: amber
toggle:
icon: octicons/sun-24
name: Switch to light mode
icon:
repo: fontawesome/brands/github
edit: material/pencil
features:
- content.code.copy
- content.code.annotate
- content.action.edit
# - navigation.footer # next/previous links in footer
- navigation.content_next # next/previous links bottom of content
# - navigation.instant # hard to use with javascript on page load
# - navigation.tracking
- navigation.indexes
- search.highlight
- search.share
- search.suggest
- navigation.icons
markdown_extensions:
- admonition
- attr_list
- def_list
- footnotes
- pymdownx.details
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.tilde
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.progressbar:
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.tabbed:
alternate_style: true
- toc:
permalink: "#"
plugins:
- search
- tags:
tags_file: tags.md
- git-revision-date-localized:
enable_creation_date: true
type: timeago
- git-committers:
repository: pydev-guide/pydev-guide.github.io
branch: main
token: !ENV MKDOCS_GIT_COMMITTERS_APIKEY
- minify:
minify_html: true
minify_js: true
minify_css: true
cache_safe: true
htmlmin_opts:
remove_comments: true
css_files:
- stylesheets/extra.css
- stylesheets/termynal.css
js_files:
- javascripts/extra.js
- javascripts/termynal.js
- spellcheck:
backends: # the backends you want to use
- codespell: # or nested configs
dictionaries: [clear, rare]
watch:
- docs
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/pydev-guide/pydev-guide.github.io
generator: false # footer attribution ... sorry :(
analytics:
provider: google
property: !ENV GOOGLE_ANALYTICS_KEY
feedback:
title: Was this page helpful?
ratings:
- icon: material/emoticon-happy-outline
name: This page was helpful
data: 1
note: >-
Thanks for your feedback!
- icon: material/emoticon-sad-outline
name: This page could be improved
data: 0
note: >-
Thanks for your feedback!<br>Help us improve this page by
<a href="https://github.com/pydev-guide/pydev-guide.github.io/issues/new/?title=[Feedback]+{title}+-+{url}"
target="_blank" rel="noopener">opening an issue</a>,
or click "Edit this page" in the sidebar to contribute.
extra_css:
- stylesheets/termynal.css
- stylesheets/extra.css
extra_javascript:
- javascripts/termynal.js
- javascripts/extra.js