docs

CZ-NIC · Sep 10, 2024 · 262c7ce · 262c7ce
1 parent 33ea7f6
commit 262c7ce
Show file tree

Hide file tree

Showing 15 changed files with 34 additions and 35 deletions.
diff --git a/asset b/asset
diff --git a/docs/asset/hello-tui.webp → asset/hello-tui.webp b/docs/asset/hello-tui.webp → asset/hello-tui.webp
diff --git a/docs/asset/hello-with-statement-tui.avif → asset/hello-with-statement-tui.avif b/docs/asset/hello-with-statement-tui.avif → asset/hello-with-statement-tui.avif
diff --git a/docs/asset/hello-with-statement.webp → asset/hello-with-statement.webp b/docs/asset/hello-with-statement.webp → asset/hello-with-statement.webp
diff --git a/docs/asset/hello-world.png → asset/hello-world.png b/docs/asset/hello-world.png → asset/hello-world.png
diff --git a/docs/asset/is_yes.avif → asset/is_yes.avif b/docs/asset/is_yes.avif → asset/is_yes.avif
diff --git a/docs/asset/not_empty.avif → asset/not_empty.avif b/docs/asset/not_empty.avif → asset/not_empty.avif
diff --git a/docs/asset/supported_types_1.avif → asset/supported_types_1.avif b/docs/asset/supported_types_1.avif → asset/supported_types_1.avif
diff --git a/docs/asset/supported_types_2.avif → asset/supported_types_2.avif b/docs/asset/supported_types_2.avif → asset/supported_types_2.avif
diff --git a/docs/asset/tag_val.avif → asset/tag_val.avif b/docs/asset/tag_val.avif → asset/tag_val.avif
diff --git a/docs/asset/validators_limit_transform.avif → asset/validators_limit_transform.avif b/docs/asset/validators_limit_transform.avif → asset/validators_limit_transform.avif
diff --git a/docs/asset b/docs/asset
@@ -0,0 +1 @@
+../asset
diff --git a/docs/index.md b/docs/index.md
@@ -94,7 +94,7 @@ pip install mininterface
 ```
 
 # Docs
-See the docs at https://cz-nic.github.io/mininterface/.
+See the docs overview at [https://cz-nic.github.io/mininterface/](https://cz-nic.github.io/mininterface/Overview.md).
 
 # Examples
 
@@ -135,4 +135,5 @@ print(m.env)
 
 # Edit values in a dialog
 m.form()
-```
+```
+
diff --git a/mininterface/validators.py b/mininterface/validators.py
@@ -78,7 +78,7 @@ def limit(minimum: int, maximum: int, lt: float | None = None, gt: float | None
     ...
 
 
-def limit(maxOrMin: int | None = None, max_: int | None = None, lt: float | None = None, gt: float | None = None, transform=False):
+def limit(maxOrMin: int | None = None, max_: int | None = None, lt: float | None = None, gt: float | None = None, transform:bool=False):
     """ Limit a number range or a string length.
 
     Either use as `limit(maximum)` or `limit(minimum, maximum)`.

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -7,38 +7,36 @@ theme:
   name: "material"
 
 plugins:
-- search
-- mkdocstrings:
-    handlers:
-      python:
-        options:
-          docstring_style: google
-          docstring_section_style: table
-          show_source: false
-          members_order: source
-
-
-
+  - search
+  - mkdocstrings:
+      handlers:
+        python:
+          options:
+            docstring_style: google
+            docstring_section_style: table
+            show_source: false
+            members_order: source
 
 markdown_extensions:
-- pymdownx.highlight:
-    anchor_linenums: true
-    use_pygments: true                  # highlight code during build time, not in javascript
-    linenums: false                     # enable line numbering
-    linenums_style: pymdownx-inline     # how lines are numbered
-- pymdownx.inlinehilite
-- pymdownx.snippets
-- admonition
-- pymdownx.details
-- pymdownx.superfences
-- pymdownx.keys # keyboard keys
-- tables
-- footnotes
+  - pymdownx.highlight:
+      anchor_linenums: true
+      use_pygments: true # highlight code during build time, not in javascript
+      linenums: false # enable line numbering
+      linenums_style: pymdownx-inline # how lines are numbered
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences
+  - pymdownx.keys # keyboard keys
+  - tables
+  - footnotes
 
 nav:
-  - Introduction: 'index.md'
-  - Run: 'run.md'
-  - Mininterface: 'Mininterface.md'
-  - Tag: 'Tag.md'
-  - Validation: 'Validation.md'
-  - Standalone: 'Standalone.md'
+  - Introduction: "index.md"
+  - Overview: "Overview.md"
+  - Run: "run.md"
+  - Mininterface: "Mininterface.md"
+  - Tag: "Tag.md"
+  - Validation: "Validation.md"
+  - Standalone: "Standalone.md"