From f9b4ea492b1e08b1108861ce3bdec234866683f2 Mon Sep 17 00:00:00 2001 From: yakhyo Date: Thu, 3 Apr 2025 16:29:09 +0900 Subject: [PATCH] docs: Create mkdocs --- .github/workflows/build.yml | 2 +- docs/about/changelog.md | 3 ++ docs/about/conduct.md | 3 ++ docs/about/license.md | 3 ++ docs/blog/index.md | 2 + docs/index.md | 3 ++ docs/installation.md | 3 ++ docs/models/age_gender.md | 3 ++ docs/models/detection.md | 3 ++ docs/models/gaze.md | 3 ++ docs/models/landmarks.md | 3 ++ docs/models/recognition.md | 3 ++ docs/overview.md | 3 ++ docs/reference/detection.md | 3 ++ docs/reference/recognition.md | 3 ++ docs/reference/uniface.md | 3 ++ docs/tutorials/integration.md | 3 ++ docs/tutorials/performance.md | 3 ++ docs/tutorials/quickstart.md | 3 ++ docs/usage.md | 3 ++ mkdocs.yml | 84 +++++++++++++++++++++++++++++++++++ requirements_mkdocs.txt | 1 + 22 files changed, 142 insertions(+), 1 deletion(-) create mode 100644 docs/about/changelog.md create mode 100644 docs/about/conduct.md create mode 100644 docs/about/license.md create mode 100644 docs/blog/index.md create mode 100644 docs/index.md create mode 100644 docs/installation.md create mode 100644 docs/models/age_gender.md create mode 100644 docs/models/detection.md create mode 100644 docs/models/gaze.md create mode 100644 docs/models/landmarks.md create mode 100644 docs/models/recognition.md create mode 100644 docs/overview.md create mode 100644 docs/reference/detection.md create mode 100644 docs/reference/recognition.md create mode 100644 docs/reference/uniface.md create mode 100644 docs/tutorials/integration.md create mode 100644 docs/tutorials/performance.md create mode 100644 docs/tutorials/quickstart.md create mode 100644 docs/usage.md create mode 100644 mkdocs.yml create mode 100644 requirements_mkdocs.txt diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index ee7fbb6..25b4980 100644 --- a/.github/workflows/build.yml +++ b/.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 diff --git a/docs/about/changelog.md b/docs/about/changelog.md new file mode 100644 index 0000000..303647e --- /dev/null +++ b/docs/about/changelog.md @@ -0,0 +1,3 @@ +# Changelog + +All notable changes to UniFace. \ No newline at end of file diff --git a/docs/about/conduct.md b/docs/about/conduct.md new file mode 100644 index 0000000..ff844c3 --- /dev/null +++ b/docs/about/conduct.md @@ -0,0 +1,3 @@ +# Code of Conduct + +Guidelines for community behavior. \ No newline at end of file diff --git a/docs/about/license.md b/docs/about/license.md new file mode 100644 index 0000000..e916a65 --- /dev/null +++ b/docs/about/license.md @@ -0,0 +1,3 @@ +# License + +MIT License or your custom license here. \ No newline at end of file diff --git a/docs/blog/index.md b/docs/blog/index.md new file mode 100644 index 0000000..c58f16c --- /dev/null +++ b/docs/blog/index.md @@ -0,0 +1,2 @@ +# Blog + diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..91ccce1 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,3 @@ +# UniFace + +Welcome to the UniFace documentation. \ No newline at end of file diff --git a/docs/installation.md b/docs/installation.md new file mode 100644 index 0000000..c7df120 --- /dev/null +++ b/docs/installation.md @@ -0,0 +1,3 @@ +# Installation + +Instructions to install UniFace. \ No newline at end of file diff --git a/docs/models/age_gender.md b/docs/models/age_gender.md new file mode 100644 index 0000000..41fef72 --- /dev/null +++ b/docs/models/age_gender.md @@ -0,0 +1,3 @@ +# Age & Gender Estimation + +Age and gender model usage. \ No newline at end of file diff --git a/docs/models/detection.md b/docs/models/detection.md new file mode 100644 index 0000000..aa8ed67 --- /dev/null +++ b/docs/models/detection.md @@ -0,0 +1,3 @@ +# Face Detection + +Details on face detection models. \ No newline at end of file diff --git a/docs/models/gaze.md b/docs/models/gaze.md new file mode 100644 index 0000000..3b4f7dd --- /dev/null +++ b/docs/models/gaze.md @@ -0,0 +1,3 @@ +# Gaze Estimation + +Gaze detection implementation and usage. \ No newline at end of file diff --git a/docs/models/landmarks.md b/docs/models/landmarks.md new file mode 100644 index 0000000..6b8d596 --- /dev/null +++ b/docs/models/landmarks.md @@ -0,0 +1,3 @@ +# Landmark Detection + +Details on landmark prediction. \ No newline at end of file diff --git a/docs/models/recognition.md b/docs/models/recognition.md new file mode 100644 index 0000000..ced611f --- /dev/null +++ b/docs/models/recognition.md @@ -0,0 +1,3 @@ +# Face Recognition + +Details on face recognition models. \ No newline at end of file diff --git a/docs/overview.md b/docs/overview.md new file mode 100644 index 0000000..73c9f03 --- /dev/null +++ b/docs/overview.md @@ -0,0 +1,3 @@ +# Overview + +High-level overview of UniFace features. \ No newline at end of file diff --git a/docs/reference/detection.md b/docs/reference/detection.md new file mode 100644 index 0000000..c013de3 --- /dev/null +++ b/docs/reference/detection.md @@ -0,0 +1,3 @@ +# Detection API Reference + +::: uniface.RetinaFace diff --git a/docs/reference/recognition.md b/docs/reference/recognition.md new file mode 100644 index 0000000..1b97ec9 --- /dev/null +++ b/docs/reference/recognition.md @@ -0,0 +1,3 @@ +# Recognition API Reference + +::: uniface.recognition.models.SphereFace diff --git a/docs/reference/uniface.md b/docs/reference/uniface.md new file mode 100644 index 0000000..68ec645 --- /dev/null +++ b/docs/reference/uniface.md @@ -0,0 +1,3 @@ +# API Reference + +::: uniface.RetinaFace diff --git a/docs/tutorials/integration.md b/docs/tutorials/integration.md new file mode 100644 index 0000000..662cdb6 --- /dev/null +++ b/docs/tutorials/integration.md @@ -0,0 +1,3 @@ +# Integration + +How to integrate UniFace into your app. \ No newline at end of file diff --git a/docs/tutorials/performance.md b/docs/tutorials/performance.md new file mode 100644 index 0000000..1e6e59c --- /dev/null +++ b/docs/tutorials/performance.md @@ -0,0 +1,3 @@ +# Performance Tips + +Speed and memory optimization. \ No newline at end of file diff --git a/docs/tutorials/quickstart.md b/docs/tutorials/quickstart.md new file mode 100644 index 0000000..29d1873 --- /dev/null +++ b/docs/tutorials/quickstart.md @@ -0,0 +1,3 @@ +# Quickstart + +Get started with UniFace quickly. \ No newline at end of file diff --git a/docs/usage.md b/docs/usage.md new file mode 100644 index 0000000..d677bb1 --- /dev/null +++ b/docs/usage.md @@ -0,0 +1,3 @@ +# Usage + +How to use UniFace with code examples. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..7085b16 --- /dev/null +++ b/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 diff --git a/requirements_mkdocs.txt b/requirements_mkdocs.txt new file mode 100644 index 0000000..ac7dc76 --- /dev/null +++ b/requirements_mkdocs.txt @@ -0,0 +1 @@ +mkdocstrings[python]