-
Notifications
You must be signed in to change notification settings - Fork 26
/
Copy pathmkdocs.yml_template
411 lines (384 loc) · 18.5 KB
/
mkdocs.yml_template
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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
site_name: Taipy
site_url: https://docs.taipy.io/en/develop
site_description: Documentation for Taipy
site_author: taipy.io
repo_url: https://github.com/avaiga/taipy
repo_name: taipy
#strict: true
copyright: © 2021-[YEAR] Avaiga
nav:
- "Release Notes":
- "Release Notes": release-notes/index.md
- "Legacy": release-notes/legacy.md
- "Contributing":
- "Contributing": contributing/index.md
- "Code of Conduct": contributing/code_of_conduct.md
- "Contributors": contributing/contributors.md
- "Tutorials":
- "Tutorials": tutorials/index.md
- "Fundamentals":
- "Fundamentals": tutorials/fundamentals/index.md
- "Getting Started": tutorials/getting_started/index.md
- "Creating a Sales Dashboard":
- "Creating a Sales Dashboard": tutorials/articles/sales_dashboard/index.md
- "1 - Visual Elements": tutorials/articles/sales_dashboard/step_01/step_01.md
- "2 - Styling": tutorials/articles/sales_dashboard/step_02/step_02.md
- "3 - Charts": tutorials/articles/sales_dashboard/step_03/step_03.md
- "4 - Multipage": tutorials/articles/sales_dashboard/step_04/step_04.md
- "Scenario management overview": tutorials/articles/scenario_management_overview/index.md
- "First Realistic application":
- "First Realistic application": tutorials/articles/complete_application/index.md
- "1 - Data visualization page": tutorials/articles/complete_application/step_01/step_01.md
- "2 - Algorithms used": tutorials/articles/complete_application/step_02/step_02.md
- "3 - Scenario configuration": tutorials/articles/complete_application/step_03/step_03.md
- "4 - Scenario page": tutorials/articles/complete_application/step_04/step_04.md
- "5 - Performance page": tutorials/articles/complete_application/step_05/step_05.md
- "Creating applications" :
- "Creating an LLM ChatBot":
- "Creating an LLM ChatBot": tutorials/articles/chatbot/index.md
- "Creating an RAG ChatBot":
- "Creating an RAG ChatBot": tutorials/articles/rag_chatbot/index.md
- "User Roles and Permissions": tutorials/articles/user_management/index.md
- "Visuals":
- "Visuals": tutorials/visuals/index.md
- "Callbacks": tutorials/articles/callbacks/index.md
- "Using Tables": tutorials/articles/using_tables/index.md
- "Long Running Callbacks": tutorials/articles/long_callbacks/index.md
- "Real-time data visualization": tutorials/articles/multithreading/index.md
- "Stylekit": tutorials/articles/css_style_kit/index.md
- "Multi-user": tutorials/articles/multi_user/index.md
- "Scenario Management":
- "Scenario Management": tutorials/scenario_management/index.md
- "Scenarios": tutorials/articles/scenarios/index.md
- "Data Nodes": tutorials/articles/the_data_nodes/index.md
- "Skippable Tasks": tutorials/articles/skippable_tasks/index.md
- "Cycles and Scopes": tutorials/articles/cycles_scopes/index.md
- "Job Execution mode": tutorials/articles/job_execution/index.md
- "Scenario Comparison": tutorials/articles/scenario_comparison/index.md
- "Scenario Subscription": tutorials/articles/scenario_subscription/index.md
- "Manage application versions": tutorials/articles/version_management/index.md
- "Integration":
- "Integration": tutorials/integration/index.md
- "Integrating Databricks": tutorials/articles/databricks/index.md
- "Integrate Third-Party Components": tutorials/articles/3rd_party_components/index.md
- "Taipy Application on Colab with Ngrok": tutorials/articles/colab_with_ngrok/index.md
- "Jupyter Notebooks": tutorials/articles/jupyter_notebooks/index.md
- "Integration with Dataiku": tutorials/articles/dataiku/index.md
- "Integration with IBM Watson Studio": tutorials/articles/ibm_watson_studio/index.md
- "Large Data":
- "Large Data": tutorials/large_data/index.md
- "Using PySpark for Large Data": tutorials/articles/pyspark/index.md
- "Large data models vs. Computer memory": tutorials/articles/large_data_models/index.md
- "Charts for Large Data": tutorials/articles/decimator/index.md
- "User Manual":
- "About Taipy's User manual": userman/index.md
- "User interface":
- "User interface": userman/gui/index.md
- "Pages":
- "Pages": userman/gui/pages/index.md
- "Navigation": userman/gui/pages/navigate/index.md
- "Dynamic page content": userman/gui/pages/partial/index.md
- "Dialogs": userman/gui/pages/dialog/index.md
- "Panes": userman/gui/pages/pane/index.md
- "Advanced": userman/gui/pages/advanced/index.md
- "Visual elements": userman/gui/viselements/introduction.md
- "Binding variables": userman/gui/binding.md
- "Callbacks": userman/gui/callbacks.md
- "Styling":
- "Styling": userman/gui/styling/index.md
- "The Stylekit": userman/gui/styling/stylekit.md
- "Notifications": userman/gui/notifications.md
- "Extension libraries":
- "Extension libraries": userman/gui/extension/index.md
- "Static elements": userman/gui/extension/static_element.md
- "Packaging extensions": userman/gui/extension/extension_packaging.md
- "Dynamic elements":
- userman/gui/extension/dynamic_element/index.md
- "Scalar properties": userman/gui/extension/dynamic_element/scalar_props.md
- "List of values": userman/gui/extension/list_of_values.md
- "Tabular data": userman/gui/extension/tabular_data.md
- "Chart elements": userman/gui/extension/chart.md
- "Accessing assets": userman/gui/extension/accessing_assets.md
- "Scenario features":
- "Data integration":
- "Data integration": userman/scenario_features/data-integration/index.md
- "Data node config": userman/scenario_features/data-integration/data-node-config.md
- "Data node usage": userman/scenario_features/data-integration/data-node-usage.md
- "Visual elements": userman/scenario_features/data-integration/data-node-vizelmts.md
- "Data node history and validity": userman/scenario_features/data-integration/data-node-history.md
- "Task orchestration":
- "Scenarios for task orchestration": userman/scenario_features/task-orchestration/index.md
- "Hello world!": userman/scenario_features/task-orchestration/hello-world.md
- "Scenario config": userman/scenario_features/task-orchestration/scenario-config.md
- "Scenario creation": userman/scenario_features/task-orchestration/scenario-creation.md
- "Scenario submission": userman/scenario_features/task-orchestration/scenario-submission.md
- "Visual elements": userman/scenario_features/task-orchestration/vizelmts.md
- "What-if analysis":
- "Scenarios for what-if analysis": userman/scenario_features/what-if-analysis/index.md
- "Multiple scenarios": userman/scenario_features/what-if-analysis/multiple-scenarios.md
- "Recurrent scenarios": userman/scenario_features/what-if-analysis/scenarios-and-cycles.md
- "Scenario comparison": userman/scenario_features/what-if-analysis/scenario-comparison.md
- "Scenario and data management":
- "Scenario and data management": userman/scenario_features/sdm/index.md
- "Data node":
- "Data node": userman/scenario_features/sdm/data-node/index.md
- "Task":
- "Task": userman/scenario_features/sdm/task/index.md
- "Scenario":
- "Scenario": userman/scenario_features/sdm/scenario/index.md
- "Scenario config": userman/scenario_features/sdm/scenario/scenario-config.md
- "Submission":
- "Submission": userman/scenario_features/sdm/submission/index.md
- "Job":
- "Job": userman/scenario_features/sdm/job/index.md
- "Sequence":
- "Sequence": userman/scenario_features/sdm/sequence/index.md
- "Cycle":
- "Cycle": userman/scenario_features/sdm/cycle/index.md
- "Track activities and Trigger actions":
- "Track activities and Trigger actions": userman/scenario_features/events/index.md
- "Event description": userman/scenario_features/events/events-description.md
- "Registration": userman/scenario_features/events/understanding-notifier-register.md
- "Examples": userman/scenario_features/events/examples.md
- "Exposing REST APIs":
- "Exposing REST APIs": userman/scenario_features/rest/index.md
- "Advanced features":
- "Configuration":
- "Configuration": userman/advanced_features/configuration/index.md
- "Configuring the GUI application": userman/advanced_features/configuration/gui-config.md
- "Configuring the Core service": userman/advanced_features/configuration/core-config.md
- "Configuring jobs execution": userman/advanced_features/configuration/job-config.md
- "Configuration checker": userman/advanced_features/configuration/config-checker.md
- "Advanced configuration": userman/advanced_features/configuration/advanced-config.md
- "Authentication and authorization":
- "Authentication and authorization": userman/advanced_features/auth/index.md
- "Authentication": userman/advanced_features/auth/authentication.md
- "Authorization and roles": userman/advanced_features/auth/authorization.md
- "Scheduler":
- "Scheduler": userman/advanced_features/scheduling/index.md
- "Operations":
- "Operations": userman/operations/index.md
- "Architecture examples": userman/operations/architectures/index.md
- "Running":
- "Running an application": userman/operations/running/index.md
- "The run() function": userman/operations/running/main-script.md
- "Protect private files": userman/operations/running/protect-files.md
- "Use an external web server": userman/operations/running/external-web-server.md
- "Run in a Notebook": userman/operations/running/notebooks.md
- "Deploying":
- "Deploying an application": userman/operations/deploying/index.md
- "On a local machine":
- "Deploying locally": userman/operations/deploying/local/index.md
- "On Linux servers":
- "Deploying on a Linux system": userman/operations/deploying/linux/index.md
- "Ubuntu": userman/operations/deploying/linux/ubuntu.md
- "RHEL": userman/operations/deploying/linux/redhat.md
- "With Docker":
- "Deployment with Docker": userman/operations/deploying/docker/index.md
- "For development": userman/operations/deploying/docker/development.md
- "For production": userman/operations/deploying/docker/production.md
- With Kubernetes:
- "Deployment with Kubernetes": userman/operations/deploying/kubernetes/index.md
- "On Azure":
- "Deploying on Azure": userman/operations/deploying/azure/index.md
- "On Heroku":
- "Deploying on Heroku": userman/operations/deploying/heroku/index.md
- "On Databricks":
- "Deploying on Databricks": userman/operations/deploying/databricks/index.md
- "Versioning":
- "Versioning system": userman/operations/versioning/index.md
- "Development mode": userman/operations/versioning/development-mode.md
- "Experiment mode": userman/operations/versioning/experiment-mode.md
- "Production mode": userman/operations/versioning/production-mode.md
- "Upgrading Taipy":
- "Upgrading Taipy": userman/operations/upgrading/index.md
- "From Taipy 3 to 4": userman/operations/upgrading/from-3.X-to-4.Y.md
- "From Taipy 2 to 3": userman/operations/upgrading/from-2.X-to-3.Y.md
- "From Taipy 2.0 to 2.1": userman/operations/upgrading/from-2.0-to-2.1.md
- "Ecosystem":
- "Command-line interface":
- "Command-line interface (CLI)": userman/ecosystem/cli/index.md
- "Help": userman/ecosystem/cli/help.md
- "Create": userman/ecosystem/cli/create.md
- "Run": userman/ecosystem/cli/run.md
- "Manage versions": userman/ecosystem/cli/manage-versions.md
- "Version": userman/ecosystem/cli/version.md
- "Taipy Studio":
- "Taipy Studio": userman/ecosystem/studio/index.md
- "Building configurations":
- "Building configurations": userman/ecosystem/studio/config/index.md
- "Managing configuration files": userman/ecosystem/studio/config/files.md
- "Configuring elements": userman/ecosystem/studio/config/elements.md
- "Graph views": userman/ecosystem/studio/config/graphview.md
- "Text edition": userman/ecosystem/studio/config/textedition.md
- "GUI Markdown support": userman/ecosystem/studio/gui.md
- "Taipy Designer":
- "Taipy Designer": userman/ecosystem/designer/index.md
[DESIGNER_CONTENT]
- "Visual Elements":
- "Visual Elements": refmans/gui/viselements/index.md
[VISELEMENTS_CONTENT]
- "Reference":
- "About Taipy's Reference manual": refmans/index.md
- "Python API":
- "Python APIs": refmans/reference/index.md
[REFERENCE_CONTENT]
- "REST API":
- "REST APIs": refmans/reference_rest/index.md
[REST_REFERENCE_CONTENT]
- "GUI Extension API":
- refmans/reference_guiext/index.md
- "taipy-gui module": refmans/reference_guiext/globals.md
- "Gallery":
- "Gallery": gallery/index.md
- "Finance":
- "Finance": gallery/finance/index.md
- "Stock Visualization": gallery/articles/stock_visualization/index.md
- "Sales Dashboard": gallery/articles/sales_dashboard/index.md
- "Commodity Trading": gallery/articles/commodity_trading/index.md
- "Fraud Detection": gallery/articles/fraud_detection/index.md
- "Decision Support":
- "Decision Support": gallery/decision_support/index.md
- "Supply Chain - 2 Echelons": gallery/articles/supply_chain/index.md
- "Supply Chain - 3 Echelons": gallery/articles/supply_chain_3_echelons/index.md
- "QSR Sales Forecasting": gallery/articles/qsr_sales_forecasting/index.md
- "Supply Chain Monitoring": gallery/articles/supply_chain_monitoring/index.md
- "Production Planning": gallery/articles/production_planning/index.md
- "Inventory Forecasting": gallery/articles/inventory_forecasting/index.md
- "Drift Detection": gallery/articles/drift_detection/index.md
- "Optimize Bar Cut Sizes": gallery/articles/bar_cutting/index.md
- "Churn Classification": gallery/articles/churn_classification/index.md
- "LLM":
- "LLM": gallery/llm/index.md
- "LLM Chatbot" : gallery/articles/chatbot/index.md
- "Vision ChatBot": gallery/articles/vision_chatbot/index.md
- "RAG ChatBot": gallery/articles/rag_chatbot/index.md
- "Talk To Taipy": gallery/articles/talk_to_taipy/index.md
- "Sentiment Analysis": gallery/articles/sentiment_analysis/index.md
- "Tweet Generation": gallery/articles/tweet_generation/index.md
- "Visualization":
- "Visualization": gallery/visualization/index.md
- "COVID Dashboard": gallery/articles/covid_dashboard/index.md
- "Industry Distribution": gallery/articles/industry_agglom/index.md
- "Image Classification": gallery/articles/image_classif/index.md
- "Realtime Pollution Dashboard" : gallery/articles/pollution_sensors/index.md
- "Other":
- "Other": gallery/other/index.md
- "Background Remover": gallery/articles/background_remover/index.md
- "Real-time Face Recognition": gallery/articles/face_recognition/index.md
- "Movie Genre Selector": gallery/articles/movie_genre_selector/index.md
theme:
name: material
language: en
custom_dir: taipy_theme
navigation_depth: 1
font:
text: Lato
icon:
logo: taipy-logo-icon
repo: fontawesome/brands/git-alt
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: custom
accent: custom
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: custom
accent: custom
toggle:
icon: material/toggle-switch
name: Switch to light mode
features:
- navigation.sections
- navigation.tabs.sticky
- navigation.tabs
- navigation.instant
- navigation.path
- navigation.indexes
- navigation.footer
- content.tabs.link
- content.code.copy
extra_css:
- assets/stylesheets/avaiga.css
extra_javascript:
- assets/js/filter.js
markdown_extensions:
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.critic
- pymdownx.caret
- pymdownx.mark
- pymdownx.tilde
- attr_list
- pymdownx.arithmatex:
generic: true
- pymdownx.highlight
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.details
- pymdownx.blocks.caption
- admonition
- toc:
baselevel: 2
permalink: true
- meta
plugins:
- include-markdown
- search:
lang: en
- mkdocstrings:
handlers:
python:
options:
show_source: false
parameter_headings: true
merge_init_into_class: false
show_root_toc_entry: false
show_root_full_path: false
show_category_heading: true
inherited_members: true
filters:
- "!^_"
- "^__init__$"
modernize_annotations: true
show_signature_annotations: true
separate_signature: true
- macros:
module_name: tools/postprocess
watch:
- taipy
- tools/postprocess.py
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/avaiga/taipy
name: Github
- icon: fontawesome/brands/discord
link: https://discord.gg/hS95mtBnrj
name: Discord
- icon: fontawesome/brands/youtube
link: https://www.youtube.com/channel/UCYZyGVj-fPgUSITZnsOQoDg
name: YouTube
- icon: fontawesome/brands/x-twitter
link: https://twitter.com/Taipy_io
name: Tweet
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/company/taipy-io/
name: LinkedIn
- icon: material/email
link: "mailto:[email protected]"
# to enable disqus, uncomment the following and put your disqus id below
# disqus: disqus_id
generator: false
exclude_docs: |
*.md_template
# uncomment the following and put your google tracking id below to enable GA
#google_analytics:
#- UA-xxx
#- auto