update docs

Author: ndonkoHenri

.github/workflows/docs.yml

@@ -11,7 +11,7 @@ on:
       - 'mkdocs.yml'
       - 'pyproject.toml'
       - '.github/workflows/docs.yml'
-      - 'src/flet_webview'
+      - 'src/flet_webview/**'
       - 'examples/webview_example/src/main.py'
 
   workflow_dispatch:    # Allow manual trigger from the GitHub Actions UI

CHANGELOG.md

@@ -7,7 +7,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased] - 2025-mm-dd
 
-## Added
+### Added
 
 - Deployed online documentation: https://flet-dev.github.io/flet-webview/
 

docs/webview.md

@@ -1,3 +1 @@
-::: flet_webview.webview.WebView
-    options:
-        show_labels: true
+::: flet_webview.webview.WebView

mkdocs.yml

@@ -63,7 +63,7 @@ extra:
     provider: mike
   social:
     - icon: fontawesome/brands/github
-      link: https://github.com/flet-dev/flet-permission-handler
+      link: https://github.com/flet-dev
     - icon: fontawesome/brands/discord
       link: https://discord.gg/bCFXYgZR3b
     - icon: fontawesome/brands/x-twitter
@@ -79,9 +79,10 @@ nav:
       - Types:
           - LogLevelSeverity: types/log_level_severity.md
           - RequestMethod: types/request_method.md
-          - WebviewConsoleMessageEvent: types/webview_console_message_event.md
-          - WebviewJavaScriptEvent: types/webview_javascript_event.md
-          - WebviewScrollEvent: types/webview_scroll_event.md
+          - Events:
+            - WebviewConsoleMessageEvent: types/webview_console_message_event.md
+            - WebviewJavaScriptEvent: types/webview_javascript_event.md
+            - WebviewScrollEvent: types/webview_scroll_event.md
   - Changelog: changelog.md
   - License: license.md
 
@@ -92,6 +93,10 @@ validation:
   unrecognized_links: warn
   anchors: warn
 
+watch:
+  - docs
+  - src
+
 # Plugins
 plugins:
   # - footnotes
@@ -101,10 +106,11 @@ plugins:
       alias_type: symlink
   - glightbox
   - mkdocstrings:
-      default_handler: python
+      default_handler: python_xref
       handlers:
-        python:
+        python_xref:
           options:
+            relative_crossrefs: true
             docstring_style: google
             show_signature_annotations: true
             signature_crossrefs: true
@@ -118,6 +124,7 @@ plugins:
             show_category_heading: false
             show_labels: false
             show_if_no_docstring: true
+            docstring_section_style: spacy
             filters:
               - "!^_"   # Exclude private members starting with only one underscore
               - "!before_update"

pyproject.toml

@@ -14,7 +14,7 @@ dependencies = [
 
 [project.urls]
 Homepage = "https://flet.dev"
-Documentation = "https://flet.dev/docs/controls/webview/"
+Documentation = "https://flet-dev.github.io/flet-webview"
 Repository = "https://github.com/flet-dev/flet-webview"
 Issues = "https://github.com/flet-dev/flet-webview/issues"
 
@@ -29,6 +29,7 @@ docs = [
     "mkdocs",
     "mkdocs-material",
     "mkdocstrings[python]",
+    "mkdocstrings-python-xref",
     "mike",
     "markdown>=3.6",
     "pymdown-extensions",