docs

Author: ndonkoHenri

.github/workflows/docs.yml

@@ -0,0 +1,58 @@
+name: docs
+
+on:
+  push:
+    branches:
+      - v1
+    paths:
+      - 'LICENSE'
+      - 'CHANGELOG.md'
+      - 'docs/**'
+      - 'mkdocs.yml'
+      - 'pyproject.toml'
+      - '.github/workflows/docs.yml'
+      - 'src/flet_webview'
+      - 'examples/webview_example/src/main.py'
+
+  workflow_dispatch:    # Allow manual trigger from the GitHub Actions UI
+
+concurrency:
+  group: "docs"                   # Prevent multiple overlapping deploys
+  cancel-in-progress: false       # Allow in-progress deploys to finish
+
+permissions:
+  contents: write  # Required to push to the gh-pages branch
+
+env:
+  GH_TOKEN: ${{ secrets.GH_TOKEN }}         # Token used by mkdocs for pushing
+  UV_SYSTEM_PYTHON: 1                       # Use system Python interpreter with uv
+
+jobs:
+  deploy:
+    name: Deploy Documentation
+    runs-on: ubuntu-latest
+    if: github.repository == github.event.repository.full_name  # don't run on forks
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Configure Git for mkdocs
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: "pyproject.toml"  # Match Python version with project config
+
+      - name: Install dependencies
+        run: |
+          uv pip install -e .
+          uv pip install --group docs
+
+      - name: Deploy to GitHub Pages
+        run: uv run mkdocs gh-deploy --force

CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased] - 2025-mm-dd
+
+## Added
+
+- Deployed online documentation: https://flet-dev.github.io/flet-webview/
+
+### Changed
+
+TBA
+
+## [0.1.0] - 2025-01-15
+
+Initial release.
+
+
+[Unreleased]: https://github.com/flet-dev/flet-lottie/compare/0.1.0...HEAD
+
+[0.1.0]: https://github.com/flet-dev/flet-lottie/releases/tag/0.1.0

docs/changelog.md

@@ -0,0 +1,5 @@
+---
+title: Changelog
+---
+
+--8<-- "CHANGELOG.md"

docs/images/favicon.ico

@@ -0,0 +1,29 @@
+# flet-lottie
+
+[![pypi](https://img.shields.io/pypi/v/flet-lottie.svg)](https://pypi.python.org/pypi/flet-lottie)
+[![downloads](https://static.pepy.tech/badge/flet-lottie/month)](https://pepy.tech/project/flet-lottie)
+[![license](https://img.shields.io/github/license/flet-dev/flet-lottie.svg)](https://github.com/flet-dev/flet-lottie/blob/main/LICENSE)
+
+A Flet extension to web content in Flet apps using WebView.
+
+It is based on the [webview_flutter](https://pub.dev/packages/webview_flutter)
+and [webview_flutter_web](https://pub.dev/packages/webview_flutter_web) Flutter packages.
+
+## Platform Support
+
+This package supports the following platforms:
+
+| Platform | Supported |
+|----------|:---------:|
+| Windows  |     ❌     |
+| macOS    |     ✅     |
+| Linux    |     ❌     |
+| iOS      |     ✅     |
+| Android  |     ✅     |
+| Web      |     ✅     |
+
+## Example
+
+```python title="main.py"
+--8<-- "examples/lottie_example/src/main.py"
+``` 

docs/images/logo.svg

@@ -0,0 +1,7 @@
+---
+title: Licence
+---
+
+```
+--8<-- "LICENSE"
+```

docs/index.md

@@ -0,0 +1 @@
+::: flet_webview.types.LogLevelSeverity

docs/license.md

@@ -0,0 +1 @@
+::: flet_webview.types.RequestMethod

docs/types/log_level_severity.md

@@ -0,0 +1 @@
+::: flet_webview.types.WebviewConsoleMessageEvent