docs: Create mkdocs

.github/workflows/build.yml

@@ -16,7 +16,7 @@ jobs:
 
     strategy:
       matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
 
     steps:
       - name: Checkout code

docs/about/changelog.md

@@ -0,0 +1,3 @@
+# Changelog
+
+All notable changes to UniFace.

docs/about/conduct.md

@@ -0,0 +1,3 @@
+# Code of Conduct
+
+Guidelines for community behavior.

docs/about/license.md

@@ -0,0 +1,3 @@
+# License
+
+MIT License or your custom license here.

docs/blog/index.md

@@ -0,0 +1,2 @@
+# Blog
+

docs/index.md

@@ -0,0 +1,3 @@
+# UniFace
+
+Welcome to the UniFace documentation.

docs/installation.md

@@ -0,0 +1,3 @@
+# Installation
+
+Instructions to install UniFace.

docs/models/age_gender.md

@@ -0,0 +1,3 @@
+# Age & Gender Estimation
+
+Age and gender model usage.

docs/models/detection.md

@@ -0,0 +1,3 @@
+# Face Detection
+
+Details on face detection models.

docs/models/gaze.md

@@ -0,0 +1,3 @@
+# Gaze Estimation
+
+Gaze detection implementation and usage.

docs/models/landmarks.md

@@ -0,0 +1,3 @@
+# Landmark Detection
+
+Details on landmark prediction.

docs/models/recognition.md

@@ -0,0 +1,3 @@
+# Face Recognition
+
+Details on face recognition models.

docs/overview.md

@@ -0,0 +1,3 @@
+# Overview
+
+High-level overview of UniFace features.

docs/reference/detection.md

@@ -0,0 +1,3 @@
+# Detection API Reference
+
+::: uniface.RetinaFace

docs/reference/recognition.md

@@ -0,0 +1,3 @@
+# Recognition API Reference
+
+::: uniface.recognition.models.SphereFace

docs/reference/uniface.md

@@ -0,0 +1,3 @@
+# API Reference
+
+::: uniface.RetinaFace

docs/tutorials/integration.md

@@ -0,0 +1,3 @@
+# Integration
+
+How to integrate UniFace into your app.

docs/tutorials/performance.md

@@ -0,0 +1,3 @@
+# Performance Tips
+
+Speed and memory optimization.

docs/tutorials/quickstart.md

@@ -0,0 +1,3 @@
+# Quickstart
+
+Get started with UniFace quickly.

docs/usage.md

@@ -0,0 +1,3 @@
+# Usage
+
+How to use UniFace with code examples.

mkdocs.yml

@@ -0,0 +1,84 @@
+site_name: uniface
+site_url: https://yakhyo.github.io/uniface/
+site_author: Yakhyokhuja Valikhujaev
+site_description: "UniFace: A Comprehensive Library for Face Detection, Recognition, Landmark Analysis, Age, and Gender Detection"
+
+repo_url: https://github.com/yakhyo/uniface
+repo_name: yakhyo/uniface
+
+theme:
+  name: material
+  features:
+    - announce.dismiss
+    - content.action.edit
+    - content.action.view
+    - content.code.annotate
+    - content.code.copy
+    - content.tooltips
+    - navigation.footer
+    - navigation.indexes
+    - navigation.sections
+    - navigation.tabs
+    - navigation.top
+    - navigation.tracking
+    - search.highlight
+    - search.share
+    - search.suggest
+    - toc.follow
+  palette:
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/lightbulb-outline
+        name: Switch to light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: indigo
+      accent: indigo
+      toggle:
+        icon: material/lightbulb
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: black
+      accent: indigo
+      toggle:
+        icon: material/lightbulb-off-outline
+        name: Switch to system preference
+  font:
+    text: Roboto
+    code: Roboto Mono
+  favicon: assets/favicon.png
+  icon:
+    logo: logo
+
+nav:
+  - Home: index.md
+  - Overview: overview.md
+  - Installation: installation.md
+  - Usage: usage.md
+  - Models:
+      - Face Detection: models/detection.md
+      - Face Recognition: models/recognition.md
+      - Landmark Detection: models/landmarks.md
+      - Age & Gender Estimation: models/age_gender.md
+      - Gaze Estimation: models/gaze.md
+  - Tutorials:
+      - Quickstart: tutorials/quickstart.md
+      - App Integration: tutorials/integration.md
+      - Performance Tips: tutorials/performance.md
+  - API Reference: 
+      - Detection: reference/detection.md
+      - Recognition: reference/recognition.md
+  - About:
+      - Changelog: about/changelog.md
+      - License: about/license.md
+      - Code of Conduct: about/conduct.md
+
+plugins:
+  - blog
+  - search:
+      separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
+  - minify:
+      minify_html: true
+  - mkdocstrings:
+      default_handler: python

requirements_mkdocs.txt

@@ -0,0 +1 @@
+mkdocstrings[python]