fix(docs): update (#8)

ndonkoHenri · web-flow · commit aa29c5e0e342 · 2025-07-27T13:34:58.000-07:00
* initial commit

* remove mdformat from pre-commit

* update mkdocs watch items | unshow `Event.get_event_field_type`

* fixes

* lint dependency group
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      - dev
     paths:
       - 'LICENSE'
       - 'CHANGELOG.md'
@@ -52,7 +53,7 @@ jobs:
       - name: Install dependencies
         run: |
           uv pip install -e .
-          uv pip install --group docs
+          uv pip install --group docs --group lint
 
       - name: Deploy to GitHub Pages
         run: uv run mkdocs gh-deploy --force
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,133 @@
-*.egg-info/
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
 build/
 develop-eggs/
 dist/
-.DS_store
-uv.lock
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+uv.lock
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# VS Code
+.vscode/
+
+# PDM
+.pdm.toml
+__pypackages__/
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,20 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.5
+    hooks:
+      # Run the linter.
+      - id: ruff
+        args: [ --fix ]
+      # Run the formatter.
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+
+  - repo: https://github.com/aio-libs/sort-all
+    rev: v1.3.0
+    hooks:
+      - id: sort-all
diff --git a/docs/audio.md b/docs/audio.md
@@ -1 +1 @@
-::: flet_audio.audio.Audio
+::: flet_audio.Audio
diff --git a/docs/types/audio_duration_change_event.md b/docs/types/audio_duration_change_event.md
@@ -1 +1 @@
-::: flet_audio.types.AudioDurationChangeEvent
+::: flet_audio.AudioDurationChangeEvent
diff --git a/docs/types/audio_position_change_event.md b/docs/types/audio_position_change_event.md
@@ -1 +1 @@
-::: flet_audio.types.AudioPositionChangeEvent
+::: flet_audio.AudioPositionChangeEvent
diff --git a/docs/types/audio_state.md b/docs/types/audio_state.md
@@ -1,3 +1,3 @@
-::: flet_audio.types.AudioState
+::: flet_audio.AudioState
     options:
         separate_signature: false
diff --git a/docs/types/audio_state_change_event.md b/docs/types/audio_state_change_event.md
@@ -1 +1 @@
-::: flet_audio.types.AudioStateChangeEvent
+::: flet_audio.AudioStateChangeEvent
diff --git a/docs/types/release_mode.md b/docs/types/release_mode.md
@@ -1,3 +1,3 @@
-::: flet_audio.types.ReleaseMode
+::: flet_audio.ReleaseMode
     options:
         separate_signature: false
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -98,13 +98,17 @@ validation:
 # Watch
 watch:
   - docs
-  - src
+  - src/flet_audio
+  - CHANGELOG.md
+  - LICENSE
+  - README.md
 
 # Plugins
 plugins:
   # - footnotes
   - search:
       lang: en
+  - open-in-new-tab
   - mike:
       alias_type: symlink
   - glightbox
@@ -134,17 +138,12 @@ plugins:
             preload_modules: [ flet ]
             filters:
               - "!^_"   # Exclude private members starting with only one underscore
-              - "!before_update"
-              - "!before_event"
-              - "!clean"
-              - "!did_mount"
-              - "!init"
-              - "!is_isolated"
-              - "!update"
-              - "!will_unmount"
+              - "!get_event_field_type"
             extensions:
               - griffe_modernized_annotations
+              - griffe_warnings_deprecated
           inventories:
+            - url: https://docs.flet.dev/objects.inv
             - url: https://docs.python.org/3/objects.inv
               domains: [ py, std ]
             - url: https://typing-extensions.readthedocs.io/en/latest/objects.inv
diff --git a/pyproject.toml b/pyproject.toml
@@ -20,22 +20,43 @@ Issues = "https://github.com/flet-dev/flet-audio/issues"
 "flutter.flet_audio" = ["**/*"]
 
 [dependency-groups]
+test = [
+    "pytest >=7.2.0",
+]
+lint = [
+    "ruff >=0.11.7",
+]
 dev = [
-    "pre-commit>=4.2.0",
-    "ruff>=0.11.7",
+    "pre-commit >=4.2.0",
+    { include-group = 'lint' },
+    { include-group = 'test' },
+]
+docs-coverage = [
+    "docstr-coverage >=2.3.2",
 ]
 docs = [
-    "mkdocs",
-    "mkdocs-material",
-    "mkdocstrings[python]",
-    "mkdocstrings-python-xref",
-    "mike",
-    "markdown>=3.6",
-    "pymdown-extensions",
-    "mkdocs-glightbox",
-    "mkdocs-section-index",
-    "griffe-modernized-annotations",
-    "pygments>=2.16",
+    "mkdocs >=1.6.1",
+    "mkdocs-material >=9.6.15",
+    "mkdocstrings-python >=1.16.12",
+    "mkdocstrings-python-xref >=1.16.3",
+    "mike >=2.1.3",
+    "markdown >=3.6",
+    "pymdown-extensions >=10.16",
+    "mkdocs-exclude >=1.0.2",
+    "mkdocs-glightbox >=0.4.0",
+    "mkdocs-open-in-new-tab >=1.0.8",
+    "mkdocs-section-index >=0.3.10",
+    "griffe-modernized-annotations >=1.0.8",
+    "griffe-warnings-deprecated >=1.1.0",
+    "pygments >=2.16",
+    "markdown-exec[ansi] >=1.11.0",
+    "pydocstyle >=6.3.0",
+    "linkcheckmd >=1.4.0",
+    { include-group = 'docs-coverage' },
+]
+all = [
+    { include-group = 'dev' },
+    { include-group = 'docs' },
 ]
 
 [build-system]
@@ -64,6 +85,7 @@ select = [
     "I"
 ]
 preview = true
+pydocstyle = { convention = 'google' }
 
 [tool.ruff.format]
 quote-style = "double"
diff --git a/src/flet_audio/__init__.py b/src/flet_audio/__init__.py
@@ -4,4 +4,14 @@
     AudioPositionChangeEvent,
     AudioState,
     AudioStateChangeEvent,
+    ReleaseMode,
 )
+
+__all__ = [
+    "Audio",
+    "AudioDurationChangeEvent",
+    "AudioPositionChangeEvent",
+    "AudioState",
+    "AudioStateChangeEvent",
+    "ReleaseMode",
+]
diff --git a/src/flet_audio/audio.py b/src/flet_audio/audio.py
diff --git a/src/flet_audio/types.py b/src/flet_audio/types.py
diff --git a/src/flutter/flet_audio/pubspec.yaml b/src/flutter/flet_audio/pubspec.yaml

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-::: flet_audio.audio.Audio`
	`1`	`+::: flet_audio.Audio`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-::: flet_audio.types.AudioDurationChangeEvent`
	`1`	`+::: flet_audio.AudioDurationChangeEvent`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-::: flet_audio.types.AudioPositionChangeEvent`
	`1`	`+::: flet_audio.AudioPositionChangeEvent`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-::: flet_audio.types.AudioStateChangeEvent`
	`1`	`+::: flet_audio.AudioStateChangeEvent`