docs: update templates

Tlaloc-Es · Dec 1, 2024 · dc6a48e · dc6a48e
1 parent 27cd8c6
commit dc6a48e
Show file tree

Hide file tree

Showing 8 changed files with 42 additions and 26 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -1,12 +1,13 @@
 version: 2
 
 build:
-  os: ubuntu-22.04
+  os: ubuntu-24.04
   tools:
     python: "3.12"
-  jobs:
-    install:
-      - pip install -r requirements-docs.txt
 
 mkdocs:
   configuration: mkdocs.yml
+
+python:
+   install:
+   - requirements: docs/requirements.txt
diff --git a/docs/api.md b/docs/api.md
diff --git 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.
+<img src="https://raw.githubusercontent.com/Tlaloc-Es/aipose/master/logo.png" width="200" height="240"/>
 
-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/docs/javascript/readthedocs.js b/docs/javascript/readthedocs.js
@@ -0,0 +1,7 @@
+document.addEventListener("DOMContentLoaded", function(event) {
+    // Trigger Read the Docs' search addon instead of Material MkDocs default
+document.querySelector(".md-search__input").addEventListener("focus", (e) => {
+        const event = new CustomEvent("readthedocs-search-show");
+        document.dispatchEvent(event);
+    });
+});
diff --git a/docs/models.md b/docs/models.md
@@ -0,0 +1,4 @@
+# Models
+
+## YoloV7
+::: aipose.models.yolov7.domain
diff --git a/requirements-docs.txt → docs/requirements.txt b/requirements-docs.txt → docs/requirements.txt
diff --git a/docs/yolov7.md b/docs/yolov7.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,4 +1,5 @@
 site_name: "AIPOSE"
+site_url: !ENV READTHEDOCS_CANONICAL_URL
 
 theme:
   name: material
@@ -9,6 +10,14 @@ theme:
     - json
 
 plugins:
+  - mkdocstrings:
+      handlers:
+        python:
+          options:
+            show_source: false
+            show_signature: true
+            search_path: ["."]
+
   - search
   - mermaid2:
       version: '9.4.3'
@@ -21,15 +30,9 @@ plugins:
           lineColor: '#F8B229'
           secondaryColor: '#006100'
           tertiaryColor: '#fff'
-  - mkdocstrings:
-      handlers:
-        python:
-          options:
-            show_source: false
-
+
 nav:
 - Home: index.md
-- API: api.md
 - Usage: usage.md
 - Frame Manager: frame_manager_availables.md
-- YOLOv7: yolov7.md
+- Models: models.md