Merge pull request #7 from ankandrew/ankandrew/0.3.1-fix-docs

Fix docs deploy

Author: ankandrew

.yamllint.yaml

@@ -0,0 +1,5 @@
+# yamllint configuration file: https://yamllint.readthedocs.io/
+extends: relaxed
+
+rules:
+  line-length: disable

Makefile

@@ -1,5 +1,6 @@
 # Directories
 SRC_PATHS := open_image_models/ test/
+YAML_PATHS := .github/ mkdocs.yml
 
 # Tasks
 .PHONY: help
@@ -10,6 +11,7 @@ help:
 	@echo "  format           : Format code using Ruff format"
 	@echo "  check_format     : Check code formatting with Ruff format"
 	@echo "  ruff             : Run Ruff linter"
+	@echo "  yamllint         : Run yamllint linter"
 	@echo "  pylint           : Run Pylint linter"
 	@echo "  mypy             : Run MyPy static type checker"
 	@echo "  lint             : Run linters (Ruff, Pylint and Mypy)"
@@ -41,6 +43,11 @@ ruff:
 	@echo "=====> Running Ruff..."
 	@poetry run ruff check $(SRC_PATHS)
 
+.PHONY: yamllint
+yamllint:
+	@echo "=====> Running yamllint..."
+	@poetry run yamllint $(YAML_PATHS)
+
 .PHONY: pylint
 pylint:
 	@echo "=====> Running Pylint..."
@@ -52,7 +59,7 @@ mypy:
 	@poetry run mypy $(SRC_PATHS)
 
 .PHONY: lint
-lint: ruff pylint mypy
+lint: ruff yamllint pylint mypy
 
 .PHONY: test
 test:

mkdocs.yml

@@ -35,19 +35,19 @@ plugins:
       handlers:
         python:
           paths: [ open_image_models ]
-        options:
-          members_order: source
-          separate_signature: true
-          filters: [ "!^_" ]
-          docstring_options:
-            ignore_init_summary: true
-          show_signature: true
-          show_source: true
-          heading_level: 2
-          show_root_full_path: false
-          merge_init_into_class: true
-          show_signature_annotations: true
-          signature_crossrefs: true
+          options:
+            members_order: source
+            separate_signature: true
+            filters: [ "!^_" ]
+            docstring_options:
+              ignore_init_summary: true
+            show_signature: true
+            show_source: true
+            heading_level: 2
+            show_root_full_path: false
+            merge_init_into_class: true
+            show_signature_annotations: true
+            signature_crossrefs: true
 extra:
   version:
     provider: mike

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "open-image-models"
-version = "0.3.0"
+version = "0.3.1"
 description = "Pre-trained image models using ONNX for fast, out-of-the-box inference."
 authors = ["ankandrew <[email protected]>"]
 readme = "README.md"
@@ -57,6 +57,7 @@ requests = "^2.32.3"
 mypy = "*"
 ruff = "*"
 pylint = "*"
+yamllint = "*"
 
 [tool.poetry.group.docs.dependencies]
 mkdocs-material = "*"