Skip to content
This repository was archived by the owner on Dec 24, 2025. It is now read-only.

Commit 23ce2b7

Browse files
ndonkoHenrindonkoHenri
authored
fix(docs): failing mkdocs build (#4)
* fix docs * update * add branch fix-docs to github-action for testing * update mkdocs watch items | unshow `Event.get_event_field_type` * fixes * lint dependency group * remove fix-docs branch from github action
1 parent 7e8d8ae commit 23ce2b7

File tree

12 files changed

+299
-93
lines changed

12 files changed

+299
-93
lines changed

‎.github/workflows/docs.yml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ on:
44
push:
55
branches:
66
- main
7+
- dev
78
paths:
89
- 'LICENSE'
910
- 'CHANGELOG.md'
@@ -52,7 +53,7 @@ jobs:
5253
- name: Install dependencies
5354
run: |
5455
uv pip install -e .
55-
uv pip install --group docs
56+
uv pip install --group docs --group lint
5657
5758
- name: Deploy to GitHub Pages
5859
run: uv run mkdocs gh-deploy --force

‎.gitignore‎

Lines changed: 132 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,135 @@
1-
*.egg-info/
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
211
build/
312
develop-eggs/
413
dist/
5-
.DS_store
6-
.venv/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
pip-wheel-metadata/
24+
share/python-wheels/
25+
*.egg-info/
26+
.installed.cfg
27+
*.egg
28+
MANIFEST
29+
30+
# PyInstaller
31+
# Usually these files are written by a python script from a template
32+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
33+
*.manifest
34+
*.spec
35+
36+
# Installer logs
37+
pip-log.txt
38+
pip-delete-this-directory.txt
39+
40+
# Unit test / coverage reports
41+
htmlcov/
42+
.tox/
43+
.nox/
44+
.coverage
45+
.coverage.*
46+
.cache
47+
nosetests.xml
48+
coverage.xml
49+
*.cover
50+
*.py,cover
51+
.hypothesis/
52+
.pytest_cache/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
target/
76+
77+
# Jupyter Notebook
78+
.ipynb_checkpoints
79+
80+
# IPython
81+
profile_default/
82+
ipython_config.py
83+
84+
# pyenv
85+
.python-version
86+
87+
# pipenv
88+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
89+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
90+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
91+
# install all needed dependencies.
92+
#Pipfile.lock
93+
uv.lock
94+
95+
# celery beat schedule file
96+
celerybeat-schedule
97+
98+
# SageMath parsed files
99+
*.sage.py
100+
101+
# Environments
102+
.env
103+
.venv
104+
env/
105+
venv/
106+
ENV/
107+
env.bak/
108+
venv.bak/
109+
110+
# Spyder project settings
111+
.spyderproject
112+
.spyproject
113+
114+
# Rope project settings
115+
.ropeproject
116+
117+
# mkdocs documentation
118+
/site
119+
120+
# mypy
121+
.mypy_cache/
122+
.dmypy.json
123+
dmypy.json
124+
125+
# Pyre type checker
126+
.pyre/
127+
128+
# VS Code
129+
.vscode/
130+
131+
# PDM
132+
.pdm.toml
133+
__pypackages__/
134+
135+
.DS_Store

‎.pre-commit-config.yaml‎

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,20 @@
11
repos:
2-
- repo: https://github.com/pycqa/isort
3-
rev: 5.13.2
2+
- repo: https://github.com/astral-sh/ruff-pre-commit
3+
rev: v0.12.5
44
hooks:
5-
- id: isort
6-
- repo: https://github.com/ambv/black
7-
rev: 22.12.0
5+
# Run the linter.
6+
- id: ruff
7+
args: [ --fix ]
8+
# Run the formatter.
9+
- id: ruff-format
10+
11+
- repo: https://github.com/pre-commit/pre-commit-hooks
12+
rev: v5.0.0
813
hooks:
9-
- id: black
14+
- id: end-of-file-fixer
15+
- id: trailing-whitespace
16+
17+
- repo: https://github.com/aio-libs/sort-all
18+
rev: v1.3.0
19+
hooks:
20+
- id: sort-all

‎docs/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,5 +59,5 @@ Ensure that your app has the necessary [permissions declared](https://flet.dev/d
5959
--8<-- "examples/permission_handler_example/src/main.py"
6060
```
6161

62-
1. The [`PermissionHandler`][(p).] instance must be added to the
63-
[`Page.services`](https://flet.dev/docs/controls/page#services) list to work properly.
62+
1. The [`PermissionHandler`][flet_permission_handler.permission_handler.PermissionHandler] instance must be added to the
63+
[`Page.services`][flet.Page.services] list to work properly.

‎docs/types/permission.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
::: flet_permission_handler.types.Permission
1+
::: flet_permission_handler.types.Permission
2+
options:
3+
separate_signature: false

‎docs/types/permission_status.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
::: flet_permission_handler.types.PermissionStatus
1+
::: flet_permission_handler.types.PermissionStatus
2+
options:
3+
separate_signature: false

‎mkdocs.yml‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -91,15 +91,20 @@ validation:
9191
unrecognized_links: warn
9292
anchors: warn
9393

94+
# Watch
9495
watch:
9596
- docs
96-
- src
97+
- src/flet_permission_handler
98+
- CHANGELOG.md
99+
- LICENSE
100+
- README.md
97101

98102
# Plugins
99103
plugins:
100104
# - footnotes
101105
- search:
102106
lang: en
107+
- open-in-new-tab
103108
- mike:
104109
alias_type: symlink
105110
- glightbox
@@ -124,21 +129,17 @@ plugins:
124129
show_labels: false
125130
show_if_no_docstring: true
126131
docstring_section_style: spacy
132+
separate_signature: true
127133
inherited_members: true
128134
preload_modules: [ flet ]
129135
filters:
130136
- "!^_" # Exclude private members starting with only one underscore
131-
- "!before_update"
132-
- "!before_event"
133-
- "!clean"
134-
- "!did_mount"
135-
- "!init"
136-
- "!is_isolated"
137-
- "!update"
138-
- "!will_unmount"
137+
- "!get_event_field_type"
139138
extensions:
140139
- griffe_modernized_annotations
140+
- griffe_warnings_deprecated
141141
inventories:
142+
- url: https://docs.flet.dev/objects.inv
142143
- url: https://docs.python.org/3/objects.inv
143144
domains: [ py, std ]
144145
- url: https://typing-extensions.readthedocs.io/en/latest/objects.inv

‎pyproject.toml‎

Lines changed: 35 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -22,22 +22,43 @@ Issues = "https://github.com/flet-dev/flet-permission-handler/issues"
2222
"flutter.flet_permission_handler" = ["**/*"]
2323

2424
[dependency-groups]
25+
test = [
26+
"pytest >=7.2.0",
27+
]
28+
lint = [
29+
"ruff >=0.11.7",
30+
]
2531
dev = [
26-
"pre-commit>=4.2.0",
27-
"ruff>=0.11.7",
32+
"pre-commit >=4.2.0",
33+
{ include-group = 'lint' },
34+
{ include-group = 'test' },
35+
]
36+
docs-coverage = [
37+
"docstr-coverage >=2.3.2",
2838
]
2939
docs = [
30-
"mkdocs",
31-
"mkdocs-material",
32-
"mkdocstrings[python]",
33-
"mkdocstrings-python-xref",
34-
"mike",
35-
"markdown>=3.6",
36-
"pymdown-extensions",
37-
"mkdocs-glightbox",
38-
"mkdocs-section-index",
39-
"griffe-modernized-annotations",
40-
"pygments>=2.16",
40+
"mkdocs >=1.6.1",
41+
"mkdocs-material >=9.6.15",
42+
"mkdocstrings-python >=1.16.12",
43+
"mkdocstrings-python-xref >=1.16.3",
44+
"mike >=2.1.3",
45+
"markdown >=3.6",
46+
"pymdown-extensions >=10.16",
47+
"mkdocs-exclude >=1.0.2",
48+
"mkdocs-glightbox >=0.4.0",
49+
"mkdocs-open-in-new-tab >=1.0.8",
50+
"mkdocs-section-index >=0.3.10",
51+
"griffe-modernized-annotations >=1.0.8",
52+
"griffe-warnings-deprecated >=1.1.0",
53+
"pygments >=2.16",
54+
"markdown-exec[ansi] >=1.11.0",
55+
"pydocstyle >=6.3.0",
56+
"linkcheckmd >=1.4.0",
57+
{ include-group = 'docs-coverage' },
58+
]
59+
all = [
60+
{ include-group = 'dev' },
61+
{ include-group = 'docs' },
4162
]
4263

4364
[build-system]
@@ -66,6 +87,7 @@ select = [
6687
"I"
6788
]
6889
preview = true
90+
pydocstyle = { convention = 'google' }
6991

7092
[tool.ruff.format]
7193
quote-style = "double"

‎src/flet_permission_handler/__init__.py‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,8 @@
11
from .permission_handler import PermissionHandler
22
from .types import Permission, PermissionStatus
3+
4+
__all__ = [
5+
"Permission",
6+
"PermissionHandler",
7+
"PermissionStatus",
8+
]

0 commit comments

Comments
 (0)