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
|
site_name: "Python Ecotrend Ista Api Documentation"
repo_url: https://github.com/Ludy87/pyecotrend-ista/
repo_name: Ludy87/pyecotrend-ista
site_author: Ludy87
nav:
- Home: index.md
- PyEcotrendIsta: pyecotrend_ista.md
- login_helper.md
- types.md
- exception_classes.md
validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn
plugins:
- search
- minify:
minify_html: true
minify_js: true
minify_css: true
htmlmin_opts:
remove_comments: true
cache_safe: true
- git-revision-date-localized:
enable_creation_date: true
fallback_to_build_date: true
- git-committers:
repository: Ludy87/pyecotrend-ista
branch: main
token: !ENV ["GITHUB_TOKEN"]
exclude:
- README.md
- git-authors
- autorefs:
resolve_closest: true
- literate-nav:
nav_file: README.md
implicit_index: true
- mkdocstrings:
enabled: !ENV [MKDOCSTRINGS_ENABLED, true]
handlers:
python:
inventories:
# YORE: SOL 3.12: Replace `3.12` with `3` within line.
- url: https://docs.python.org/3.12/objects.inv
domains: [std, py]
paths: [src, scripts, .]
options:
line_length: 80
docstring_options:
ignore_init_summary: true
docstring_section_style: list
members_order: source
heading_level: 2
inherited_members: true
merge_init_into_class: true
parameter_headings: true
separate_signature: true
show_bases: false
show_inheritance_diagram: true
show_root_heading: true
show_root_full_path: true
show_source: true
show_signature_annotations: true
show_symbol_type_heading: true
show_symbol_type_toc: true
signature_crossrefs: true
summary: true
docstring_style: numpy
theme:
name: material
icon:
logo: material/library
features:
- announce.dismiss
- content.code.annotate
- content.code.copy
- content.tooltips
- navigation.expand
- navigation.footer
- navigation.indexes
- navigation.instant
- navigation.instant.progress
- navigation.instant.prefetch
- navigation.path
# - navigation.sections
# - navigation.tabs
- navigation.tabs.sticky
# - navigation.top
- search.highlight
- search.suggest
- search.share
- 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
markdown_extensions:
- admonition
- codehilite
- attr_list
- github-callouts
# - callouts
- footnotes
- pymdownx.details
- pymdownx.blocks.tab:
alternate_style: true
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.snippets:
base_path: [!relative $config_dir]
check_paths: true
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
- toc:
permalink: true
- def_list
- tables
- pymdownx.highlight:
use_pygments: false
anchor_linenums: true
- pymdownx.snippets
- pymdownx.superfences
- mdx_gh_links:
user: Ludy87
repo: pyecotrend-ista
- mkdocs-click
watch:
- docs
|
