Skip to content

Commit

Permalink
docs: update templates
Browse files Browse the repository at this point in the history
  • Loading branch information
Tlaloc-Es committed Dec 1, 2024
1 parent 27cd8c6 commit 65efede
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 17 deletions.
2 changes: 2 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ build:
jobs:
install:
- pip install -r requirements-docs.txt
commands:
- export PYTHONPATH=$(pwd)

mkdocs:
configuration: mkdocs.yml
5 changes: 0 additions & 5 deletions docs/api.md

This file was deleted.

19 changes: 15 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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**.
3 changes: 3 additions & 0 deletions docs/models.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Models

::: aipose.models
5 changes: 0 additions & 5 deletions docs/yolov7.md

This file was deleted.

8 changes: 5 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,14 @@ plugins:
- mkdocstrings:
handlers:
python:
setup_commands:
- "import sys; sys.path.insert(0, '.')"
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

0 comments on commit 65efede

Please sign in to comment.