diff --git a/README.md b/README.md index 11bb3c2..cb58daa 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@

- +

Library to use pose estimation in your projects easily. diff --git a/docs/api.md b/docs/api.md deleted file mode 100644 index dae64f4..0000000 --- a/docs/api.md +++ /dev/null @@ -1,5 +0,0 @@ -# Models - -## YoloV7 - -::: aipose.models.yolov7 diff --git a/docs/index.md b/docs/index.md index 5df5619..67a0713 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,7 +1,18 @@ -Welcome to AIPOSE's Documentation +# Welcome to AIPOSE Documentation -aipose is a Python library for using pose estimation easily in your Python project. +![AIPOSE Logo](logo.png) -Check out the usage section for further information, including how to install the project. +**AIPOSE** is a powerful and user-friendly Python library designed to make pose estimation simple and efficient for your Python projects. -Note: This project is under active development. +Whether you're working on applications in computer vision, motion tracking, or interactive systems, **AIPOSE** provides a seamless integration of pose estimation capabilities. + +--- + +### 🚀 **Why Use AIPOSE?** +- Simplifies pose estimation workflows. +- Flexible and easy-to-integrate with existing Python projects. +- Supports multiple pose estimation models. + +--- + +Ready to dive in? Explore the documentation to unleash the full potential of pose estimation with **AIPOSE**. diff --git a/logo.png b/docs/logo.png similarity index 100% rename from logo.png rename to docs/logo.png diff --git a/docs/models.md b/docs/models.md new file mode 100644 index 0000000..b89e95a --- /dev/null +++ b/docs/models.md @@ -0,0 +1,3 @@ +# Models + +::: aipose.models \ No newline at end of file diff --git a/docs/yolov7.md b/docs/yolov7.md deleted file mode 100644 index 363cdeb..0000000 --- a/docs/yolov7.md +++ /dev/null @@ -1,5 +0,0 @@ -# Models - -## YoloV7 - - diff --git a/mkdocs.yml b/mkdocs.yml index 174ae82..a629086 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -26,10 +26,10 @@ plugins: python: options: show_source: false - + show_signature: true + nav: - Home: index.md -- API: api.md - Usage: usage.md - Frame Manager: frame_manager_availables.md -- YOLOv7: yolov7.md +- Models: models.md