/
mkdocs.yml
272 lines (262 loc) · 11 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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
site_name: pyfuzzylite
site_description: "a fuzzy logic control library in Python"
site_author: Juan Rada-Vilela, PhD
#site_url: https://fuzzylite.com
repo_name: "fuzzylite/pyfuzzylite"
repo_url: "https://github.com/fuzzylite/pyfuzzylite"
#edit_uri: "edit/development/docs/"
copyright: Copyright© 2010-<script>document.write(new Date().getFullYear())</script> FuzzyLite by Juan Rada-Vilela. All rights reserved.
watch: [ README.md, fuzzylite/, docs/ ]
theme:
name: material
favicon: image/fuzzylite.svg
logo: image/fuzzylite.svg
palette:
primary: darkblue
accent: blue
icon:
repo: fontawesome/brands/github
features:
- navigation # Sections are included in the navigation on the left.
- navigation.tabs # Tabs for navigation
- navigation.tabs.sticky # Tabs remain visible when scrolling down
- navigation.top # "Back to top" when reaching bottom of page
- toc.follow # follow content in TOC
- toc.integrate # TOC integrated in left panel
#- content.action.edit # Edit documentation
validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn
extra:
social:
- icon: fontawesome/brands/python
link: https://pypi.org/project/pyfuzzylite
- icon: fontawesome/brands/github
link: https://github.com/fuzzylite/
markdown_extensions:
- admonition # Render blocks (eg, todo, note, info)
- pymdownx.arithmatex: # Render LaTeX via MathJax
generic: true
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- attr_list
- md_in_html # align images
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.magiclink # Convert URLs into links
- pymdownx.details # Collapsible blocks
- pymdownx.b64 # Insert images from relative paths
- pymdownx.tabbed: # Content tabs
alternate_style: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- toc:
permalink: true # "¤" # Adds a clickable permalink to each section heading
toc_depth: 4
extra_javascript:
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
plugins:
- search:
separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#+search.separator
- autorefs # Cross-links to headings
- mkdocstrings:
default_handler: python
handlers:
python:
paths: [ "fuzzylite/" ]
options:
# https://mkdocstrings.github.io/python/usage/
# General options:
show_source: false
# Headings options:
heading_level: 2
show_root_heading: true
show_root_toc_entry: true
show_root_full_path: false
show_root_members_full_path: false
show_object_full_path: false
show_category_heading: true
show_symbol_type_heading: true
show_symbol_type_toc: true
# Members options:
inherited_members: false # true
members: true
members_order: alphabetical
group_by_category: true
show_submodules: true
# Docstrings options:
docstring_style: google
merge_init_into_class: false
show_if_no_docstring: true
# Signatures/annotations options:
annotations_path: brief
line_length: 120
show_signature_annotations: true
signature_crossrefs: true
separate_signature: true
import:
- https://docs.python.org/3/objects.inv
- https://numpy.org/doc/stable/objects.inv
not_in_nav: |
fuzzylite/__all__/activation.md
fuzzylite/__all__/benchmark.md
fuzzylite/__all__/defuzzifier.md
fuzzylite/__all__/engine.md
fuzzylite/__all__/exporter.md
fuzzylite/__all__/factory.md
fuzzylite/__all__/hedge.md
fuzzylite/__all__/importer.md
fuzzylite/__all__/library.md
fuzzylite/__all__/norm.md
fuzzylite/__all__/operation.md
fuzzylite/__all__/rule.md
fuzzylite/__all__/term.md
fuzzylite/__all__/types.md
fuzzylite/__all__/variable.md
nav:
- pyfuzzylite: index.md
- Documentation:
- activation:
- Activation: fuzzylite/activation/Activation.md
- First: fuzzylite/activation/First.md
- General: fuzzylite/activation/General.md
- Highest: fuzzylite/activation/Highest.md
- Last: fuzzylite/activation/Last.md
- Lowest: fuzzylite/activation/Lowest.md
- Proportional: fuzzylite/activation/Proportional.md
- Threshold: fuzzylite/activation/Threshold.md
- benchmark:
- Benchmark: fuzzylite/benchmark/Benchmark.md
- defuzzifier:
- Bisector: fuzzylite/defuzzifier/Bisector.md
- Centroid: fuzzylite/defuzzifier/Centroid.md
- Defuzzifier: fuzzylite/defuzzifier/Defuzzifier.md
- IntegralDefuzzifier: fuzzylite/defuzzifier/IntegralDefuzzifier.md
- LargestOfMaximum: fuzzylite/defuzzifier/LargestOfMaximum.md
- MeanOfMaximum: fuzzylite/defuzzifier/MeanOfMaximum.md
- SmallestOfMaximum: fuzzylite/defuzzifier/SmallestOfMaximum.md
- WeightedAverage: fuzzylite/defuzzifier/WeightedAverage.md
- WeightedDefuzzifier: fuzzylite/defuzzifier/WeightedDefuzzifier.md
- WeightedSum: fuzzylite/defuzzifier/WeightedSum.md
- engine:
- Engine: fuzzylite/engine/Engine.md
- exporter:
- Exporter: fuzzylite/exporter/Exporter.md
- FldExporter: fuzzylite/exporter/FldExporter.md
- FllExporter: fuzzylite/exporter/FllExporter.md
- PythonExporter: fuzzylite/exporter/PythonExporter.md
- factory:
- ActivationFactory: fuzzylite/factory/ActivationFactory.md
- CloningFactory: fuzzylite/factory/CloningFactory.md
- ConstructionFactory: fuzzylite/factory/ConstructionFactory.md
- DefuzzifierFactory: fuzzylite/factory/DefuzzifierFactory.md
- FactoryManager: fuzzylite/factory/FactoryManager.md
- FunctionFactory: fuzzylite/factory/FunctionFactory.md
- HedgeFactory: fuzzylite/factory/HedgeFactory.md
- SNormFactory: fuzzylite/factory/SNormFactory.md
- TNormFactory: fuzzylite/factory/TNormFactory.md
- TermFactory: fuzzylite/factory/TermFactory.md
- hedge:
- Any: fuzzylite/hedge/Any.md
- Extremely: fuzzylite/hedge/Extremely.md
- Hedge: fuzzylite/hedge/Hedge.md
- HedgeFunction: fuzzylite/hedge/HedgeFunction.md
- HedgeLambda: fuzzylite/hedge/HedgeLambda.md
- Not: fuzzylite/hedge/Not.md
- Seldom: fuzzylite/hedge/Seldom.md
- Somewhat: fuzzylite/hedge/Somewhat.md
- Very: fuzzylite/hedge/Very.md
- importer:
- FllImporter: fuzzylite/importer/FllImporter.md
- Importer: fuzzylite/importer/Importer.md
- library:
- Information: fuzzylite/library/Information.md
- Representation: fuzzylite/library/Representation.md
- Settings: fuzzylite/library/Settings.md
- array: fuzzylite/library/array.md
- inf: fuzzylite/library/inf.md
- information: fuzzylite/library/_information.md
- nan: fuzzylite/library/nan.md
- repr: fuzzylite/library/repr.md
- representation: fuzzylite/library/_representation.md
- scalar: fuzzylite/library/scalar.md
- settings: fuzzylite/library/_settings.md
- to_float: fuzzylite/library/to_float.md
- norm:
- AlgebraicProduct: fuzzylite/norm/AlgebraicProduct.md
- AlgebraicSum: fuzzylite/norm/AlgebraicSum.md
- BoundedDifference: fuzzylite/norm/BoundedDifference.md
- BoundedSum: fuzzylite/norm/BoundedSum.md
- DrasticProduct: fuzzylite/norm/DrasticProduct.md
- DrasticSum: fuzzylite/norm/DrasticSum.md
- EinsteinProduct: fuzzylite/norm/EinsteinProduct.md
- EinsteinSum: fuzzylite/norm/EinsteinSum.md
- HamacherProduct: fuzzylite/norm/HamacherProduct.md
- HamacherSum: fuzzylite/norm/HamacherSum.md
- Maximum: fuzzylite/norm/Maximum.md
- Minimum: fuzzylite/norm/Minimum.md
- NilpotentMaximum: fuzzylite/norm/NilpotentMaximum.md
- NilpotentMinimum: fuzzylite/norm/NilpotentMinimum.md
- Norm: fuzzylite/norm/Norm.md
- NormFunction: fuzzylite/norm/NormFunction.md
- NormLambda: fuzzylite/norm/NormLambda.md
- NormalizedSum: fuzzylite/norm/NormalizedSum.md
- SNorm: fuzzylite/norm/SNorm.md
- TNorm: fuzzylite/norm/TNorm.md
- UnboundedSum: fuzzylite/norm/UnboundedSum.md
- operation:
- Op: fuzzylite/operation/Op.md
- Operation: fuzzylite/operation/Operation.md
- rule:
- Antecedent: fuzzylite/rule/Antecedent.md
- Consequent: fuzzylite/rule/Consequent.md
- Expression: fuzzylite/rule/Expression.md
- Operator: fuzzylite/rule/Operator.md
- Proposition: fuzzylite/rule/Proposition.md
- Rule: fuzzylite/rule/Rule.md
- RuleBlock: fuzzylite/rule/RuleBlock.md
- term:
- Activated: fuzzylite/term/Activated.md
- Aggregated: fuzzylite/term/Aggregated.md
- Arc: fuzzylite/term/Arc.md
- Bell: fuzzylite/term/Bell.md
- Binary: fuzzylite/term/Binary.md
- Concave: fuzzylite/term/Concave.md
- Constant: fuzzylite/term/Constant.md
- Cosine: fuzzylite/term/Cosine.md
- Discrete: fuzzylite/term/Discrete.md
- Function: fuzzylite/term/Function.md
- Gaussian: fuzzylite/term/Gaussian.md
- GaussianProduct: fuzzylite/term/GaussianProduct.md
- Linear: fuzzylite/term/Linear.md
- PiShape: fuzzylite/term/PiShape.md
- Ramp: fuzzylite/term/Ramp.md
- Rectangle: fuzzylite/term/Rectangle.md
- SShape: fuzzylite/term/SShape.md
- SemiEllipse: fuzzylite/term/SemiEllipse.md
- Sigmoid: fuzzylite/term/Sigmoid.md
- SigmoidDifference: fuzzylite/term/SigmoidDifference.md
- SigmoidProduct: fuzzylite/term/SigmoidProduct.md
- Spike: fuzzylite/term/Spike.md
- Term: fuzzylite/term/Term.md
- Trapezoid: fuzzylite/term/Trapezoid.md
- Triangle: fuzzylite/term/Triangle.md
- ZShape: fuzzylite/term/ZShape.md
- types:
- Array: fuzzylite/types/Array.md
- Scalar: fuzzylite/types/Scalar.md
- ScalarArray: fuzzylite/types/ScalarArray.md
- variable:
- InputVariable: fuzzylite/variable/InputVariable.md
- OutputVariable: fuzzylite/variable/OutputVariable.md
- Variable: fuzzylite/variable/Variable.md