Commit f5e1581
v1: Use macros across the docs, move "raises" to properties, restructure navigation (#5681)
* Refactor docs to use templated metadata and helpers
Updated documentation files for Flet controls to use frontmatter metadata (class_name, examples, example_images) and templated helper functions (class_summary, class_members, class_all_options). Example paths and image references now use template variables for consistency. Removed browsercontextmenu.md. This improves maintainability and enables more dynamic documentation generation.
* Refactor and clarify docstring Raises sections in controls
Moved and consolidated 'Raises' documentation for validation errors into relevant property docstrings across multiple control classes. This improves clarity and consistency in error documentation for Flet controls, making it easier for developers to understand validation requirements for each property.
* Refactor image embedding in docs to use macro
Replaced Markdown image syntax and caption comments with the `{{ image(...) }}` template across multiple documentation files for consistency and improved maintainability.
* Restructure and update Flet documentation
Deleted outdated contributing and tutorials docs, moved extension and reference docs to new locations, updated links and section headers for clarity, and improved organization of documentation files. This refactor streamlines navigation and prepares for future documentation improvements.
* cleanup CI workflow
---------
Co-authored-by: ndonkoHenri <[email protected]>1 parent 655f36b commit f5e1581
File tree
270 files changed
+2489
-2870
lines changed- .github/workflows
- sdk/python/packages/flet
- docs
- ads
- cli
- contributing
- extensions
- controls
- canvas
- cupertinoactionsheet
- datatable
- dropdown
- tabs
- cookbook
- extend
- extras/macros
- getting-started
- publish
- web
- reference
- testing
- tutorials
- types
- src/flet/controls
- core
- cupertino
- material
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
270 files changed
+2489
-2870
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
351 | 351 | | |
352 | 352 | | |
353 | 353 | | |
354 | | - | |
355 | 354 | | |
356 | 355 | | |
357 | 356 | | |
| |||
534 | 533 | | |
535 | 534 | | |
536 | 535 | | |
| 536 | + | |
537 | 537 | | |
538 | 538 | | |
539 | 539 | | |
540 | | - | |
541 | | - | |
542 | 540 | | |
543 | 541 | | |
544 | 542 | | |
| |||
591 | 589 | | |
592 | 590 | | |
593 | 591 | | |
594 | | - | |
| 592 | + | |
595 | 593 | | |
596 | 594 | | |
597 | 595 | | |
| |||
615 | 613 | | |
616 | 614 | | |
617 | 615 | | |
618 | | - | |
619 | | - | |
620 | 616 | | |
621 | | - | |
| 617 | + | |
622 | 618 | | |
623 | 619 | | |
624 | 620 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
17 | | - | |
18 | | - | |
19 | | - | |
| 17 | + | |
| 18 | + | |
20 | 19 | | |
21 | 20 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
39 | 39 | | |
40 | 40 | | |
41 | 41 | | |
42 | | - | |
43 | | - | |
44 | | - | |
| 42 | + | |
| 43 | + | |
45 | 44 | | |
46 | 45 | | |
47 | 46 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
17 | | - | |
18 | | - | |
19 | | - | |
| 17 | + | |
| 18 | + | |
20 | 19 | | |
21 | 20 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
2 | | - | |
3 | | - | |
| 1 | + | |
4 | 2 | | |
5 | 3 | | |
6 | 4 | | |
| |||
Lines changed: 0 additions & 1 deletion
This file was deleted.
This file was deleted.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
1 | 9 | | |
2 | 10 | | |
3 | 11 | | |
4 | 12 | | |
5 | 13 | | |
6 | 14 | | |
7 | 15 | | |
8 | | - | |
| 16 | + | |
9 | 17 | | |
10 | 18 | | |
11 | | - | |
12 | | - | |
13 | | - | |
| 19 | + | |
| 20 | + | |
14 | 21 | | |
15 | | - | |
| 22 | + | |
0 commit comments