-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
147 lines (136 loc) · 3.53 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
site_name: Toggl API Wrapper
site_url: https://ddkasa.github.io/toggl-api-wrapper/
use_directory_urls: false
site_description: Simple Toggl API wrapper for non-premium features.
site_author: David Kasakaits
docs_dir: "docs/"
repo_name: ddkasa/toggl-api-wrapper
repo_url: https://www.github.com/ddkasa/toggl-api-wrapper
edit_uri: blob/master/docs/
theme:
name: material
features:
- announce.dismiss
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
- content.code.select
- content.tabs.link
- content.tooltips
- navigation.footer
- navigation.indexes
- navigation.sections
- navigation.tabs
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/link
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/toggle-switch
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: indigo
toggle:
icon: material/toggle-switch-off
name: Switch to system preference
font:
text: Roboto
code: Roboto Mono
nav:
- Getting Started:
- Overview: README.md
- Installation: user-guide/installation.md
- Examples: user-guide/examples.md
- API Reference:
- Overview: api-guide/index.md
- Configuration: api-guide/config.md
- Endpoint: api-guide/endpoint.md
- Cache: api-guide/cache.md
- Exceptions: api-guide/exceptions.md
- Models: api-guide/model.md
- User: api-guide/user.md
- Organization: api-guide/organization.md
- Workspace: api-guide/workspace.md
- Trackers: api-guide/tracker.md
- Projects: api-guide/project.md
- Client: api-guide/client.md
- Tags: api-guide/tag.md
- Reports: api-guide/reports.md
- Changelog: CHANGELOG.md
- About:
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
extra_css:
- stylesheet/extra.css
exclude_docs: |
*.py
markdown_extensions:
- toc:
permalink: true
- attr_list
- def_list
- tables
- pymdownx.highlight:
use_pygments: true
- pymdownx.snippets
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:mermaid2.fence_mermaid_custom
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- callouts
- mdx_gh_links:
user: mkdocs
repo: mkdocs
- mkdocs-click
- md_in_html
- admonition
copyright: Copyright © 2025 David Kasakaitis
# hooks:
# - docs/hooks.py
plugins:
- search
- autorefs
- glightbox
- macros
- mermaid2
- literate-nav:
nav_file: docs/README.md
implicit_index: true
- mkdocstrings:
handlers:
python:
options:
docstring_section_style: spacy
members_order: source
show_root_heading: true
show_source: false
show_symbol_type_heading: true
show_symbol_type_toc: true
signature_crossrefs: true
show_signature_annotations: true
separate_signature: true
summary: true
line_length: 79
- callouts
- panzoom:
full_screen: true
watch:
- toggl_api