docs update

ndonkoHenri · ndonkoHenri · commit dbf78f5b8479 · 2025-06-19T16:12:27.000+02:00
diff --git a/docs/assets/example-2.gif b/docs/assets/example-2.gif
diff --git a/docs/index.md b/docs/index.md
@@ -22,52 +22,47 @@ This package supports the following platforms:
 | Android  |     ✅     |
 | Web      |     ✅     |
 
-## Installation
+## Usage
 
-Add dependency to `pyproject.toml` of your Flet app:
+### Installation
 
-```
-dependencies = [
-  "flet-datatable2 @ git+https://github.com/flet-dev/flet_datatable2.git",
-  "flet",
-]
+To install the `flet-datatable2` package and add it to your project dependencies:
+
+=== "uv"
+
+```bash
+uv add flet-datatable2
 ```
 
-Build your app:
+=== "pip"
+
+```bash
+pip install flet-datatable2
 ```
-flet build macos -v
+
+    You will have to manually add this package to your `requirements.txt` or `pyproject.toml`.
+
+=== "poetry"
+
+```bash
+poetry add flet-datatable2
 ```
 
 ## Examples
 
-[Live example](https://flet-controls-gallery.fly.dev/layout/datatable2)
+[Live demo](https://flet-controls-gallery.fly.dev/layout/datatable2)
 
-### DataTable2 with `empty` property and no data rows
+### Example 1
 
+```python
+--8<-- "examples/datatable2_example/src/example-1.py"
 ```
-import flet as ft
-from flet_datatable2 import DataColumn2, DataTable2
-
-def main(page: ft.Page):
-    page.add(
-        DataTable2(
-            columns=[
-                DataColumn2(ft.Text("First name")),
-                DataColumn2(ft.Text("Last name")),
-                DataColumn2(ft.Text("Age"), numeric=True),
-            ],
-            empty=ft.Text("This table is empty."),
-        ),
-    )
-
-
-ft.app(main)
-```
-
-### DataTable2 with fixed heading row and sorting
 
-<img src="assets/datatable2-example.gif">
-
-See source code for this example [here](https://github.com/flet-dev/flet_datatable2/tree/main/examples/flet_datatable2_example/src).
+### Example 2
 
+![DataTable2 example 2](assets/example-2.gif)
 
+```
+```python
+--8<-- "examples/datatable2_example/src/example-2.py"
+```
diff --git a/examples/datatable2_example/pyproject.toml b/examples/datatable2_example/pyproject.toml
@@ -4,44 +4,18 @@ version = "1.0.0"
 description = ""
 readme = "README.md"
 requires-python = ">=3.10"
-authors = [
-    { name = "Flet developer", email = "you@example.com" }
-]
+authors = [{ name = "Flet Contributors", email = "hello@flet.dev" }]
 dependencies = [
   "flet-datatable2",
   "flet",
 ]
 
+# Docs: https://flet.dev/docs/publish
 [tool.flet]
-# org name in reverse domain name notation, e.g. "com.mycompany".
-# Combined with project.name to build bundle ID for iOS and Android apps
 org = "com.mycompany"
-
-# project display name that is used as an app title on Android and iOS home screens,
-# shown in window titles and about app dialogs on desktop.
 product = "flet-datatable2-example"
-
-# company name to display in about app dialogs
-
-# copyright text to display in about app dialogs
+company = "Flet"
 copyright = "Copyright (C) 2025 by Flet"
 
 [tool.flet.app]
-path = "src"
-
-[tool.flet.dev_packages]
-flet-datatable2 = "../.." # relative path
-flet = "git+https://github.com/flet-dev/flet.git@v1#subdirectory=sdk/python/packages/flet"
-
-[tool.uv]
-dev-dependencies = [
-    "flet",
-    "flet-cli",
-    "flet-desktop",
-]
-
-[tool.uv.sources]
-flet-datatable2 = { path = "../../", editable = true }
-flet = { git = "https://github.com/flet-dev/flet", subdirectory = "sdk/python/packages/flet", rev = "v1" }
-flet-cli = { git = "https://github.com/flet-dev/flet", subdirectory = "sdk/python/packages/flet-cli", rev = "v1" }
-flet-desktop = { git = "https://github.com/flet-dev/flet", subdirectory = "sdk/python/packages/flet-desktop", rev = "v1" }
+path = "src"
diff --git a/examples/datatable2_example/src/example-1.py b/examples/datatable2_example/src/example-1.py
@@ -0,0 +1,19 @@
+import flet as ft
+
+import flet_datatable2 as fdt
+
+
+def main(page: ft.Page):
+    page.add(
+        fdt.DataTable2(
+            empty=ft.Text("This table is empty."),
+            columns=[
+                fdt.DataColumn2(ft.Text("First name")),
+                fdt.DataColumn2(ft.Text("Last name")),
+                fdt.DataColumn2(ft.Text("Age"), numeric=True),
+            ],
+        ),
+    )
+
+
+ft.run(main)
diff --git a/examples/datatable2_example/src/example-2.py b/examples/datatable2_example/src/example-2.py
@@ -1,7 +1,8 @@
 import flet as ft
-import flet_datatable2 as ftd
 from data import desserts
 
+import flet_datatable2 as ftd
+
 
 def main(page: ft.Page):
     page.vertical_alignment = ft.MainAxisAlignment.CENTER
@@ -102,4 +103,5 @@ def get_data_rows(desserts):
         ),
     )
 
+
 ft.run(main)
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -47,6 +47,7 @@ theme:
     - content.code.annotate
     - content.code.copy
     - content.code.select
+    - content.tabs.link
     # - navigation.tabs
     - navigation.instant
     - navigation.tracking
@@ -103,6 +104,7 @@ plugins:
   - mike:
       alias_type: symlink
   - glightbox
+  - section-index
   - mkdocstrings:
       default_handler: python_xref
       handlers:
@@ -122,35 +124,55 @@ plugins:
             show_category_heading: false
             show_labels: false
             show_if_no_docstring: true
+            docstring_section_style: spacy
             inherited_members: true
-            preload_modules: [flet]
+            preload_modules: [ flet ]
             filters:
               - "!^_"   # Exclude private members starting with only one underscore
-              - "!before_update"  # Exclude before_update method
+              - "!before_update"
           inventories:
             - url: https://docs.python.org/3/objects.inv
               domains: [ py, std ]
             - url: https://typing-extensions.readthedocs.io/en/latest/objects.inv
 
 # Markdown Extensions
 markdown_extensions:
+  - abbr
   - admonition
+  - attr_list
+  - def_list
+  - footnotes
+  - md_in_html
   - toc:
       permalink: "#"
+
+  # Python Markdown Extensions
+  - pymdownx.arithmatex:
+      generic: true
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.details
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
   - pymdownx.highlight:
       anchor_linenums: true
       line_spans: __span
       pygments_lang_class: true
   - pymdownx.inlinehilite
-  - pymdownx.snippets
+  - pymdownx.keys
+  - pymdownx.mark
+  - pymdownx.smartsymbols
   - pymdownx.superfences
-  - pymdownx.details
+  - pymdownx.snippets
   - pymdownx.magiclink:
       repo_url_shorthand: true
   - pymdownx.tabbed:
       alternate_style: true
-  - attr_list
-  - md_in_html
-  - def_list
+      slugify: !!python/object/apply:pymdownx.slugs.slugify
+        kwds:
+          case: lower
   - pymdownx.tasklist:
       custom_checkbox: true
+  - pymdownx.tilde
diff --git a/pyproject.toml b/pyproject.toml
@@ -32,6 +32,7 @@ docs = [
     "markdown>=3.6",
     "pymdown-extensions",
     "mkdocs-glightbox",
+    "mkdocs-section-index",
     "pygments>=2.16",
 ]
 
@@ -43,4 +44,36 @@ license-files = []
 
 [build-system]
 requires = ["setuptools"]
-build-backend = "setuptools.build_meta"
+build-backend = "setuptools.build_meta"
+
+[tool.ruff]
+line-length = 88
+target-version = "py39"
+fix = true
+show-fixes = true
+
+[tool.ruff.lint]
+select = [
+    # pycodestyle
+    "E",
+    # Pyflakes
+    "F",
+    # pyupgrade
+    "UP",
+    # flake8-bugbear
+    "B",
+    # flake8-simplify
+    "SIM",
+    # isort
+    "I"
+]
+ignore = [
+    # Pyflakes
+    "F401", # unused import
+]
+preview = true
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+line-ending = "auto"
diff --git a/src/flet_datatable2/datarow2.py b/src/flet_datatable2/datarow2.py
@@ -4,6 +4,7 @@
 
 __all__ = ["DataRow2"]
 
+
 @ft.control("DataRow2")
 class DataRow2(ft.DataRow):
     """
@@ -27,28 +28,28 @@ class DataRow2(ft.DataRow):
     Falls back to `data_row_height` if not set.
     """
 
-    on_double_tap: ft.OptionalControlEventCallable = None
+    on_double_tap: ft.OptionalControlEventHandler["DataRow2"] = None
     """
     Fires when the row is double-tapped.
     
     Ignored if the tapped cell has a `tap` handler.
     """
 
-    on_secondary_tap: ft.OptionalControlEventCallable = None
+    on_secondary_tap: ft.OptionalControlEventHandler["DataRow2"] = None
     """
     Fires when the row is right-clicked (secondary tap).
     
     Ignored if the tapped cell has a `tap` handler.
     """
 
-    on_secondary_tap_down: ft.OptionalControlEventCallable = None
+    on_secondary_tap_down: ft.OptionalControlEventHandler["DataRow2"] = None
     """
     Fires when the row is right-clicked (secondary tap down).
     
     Ignored if the tapped cell has a `tap` handler.
     """
 
-    on_tap: ft.OptionalEventCallable[ft.TapEvent] = None
+    on_tap: ft.OptionalEventHandler[ft.TapEvent["DataRow2"]] = None
     """
     Fires when the row is tapped.
     
