Skip to content

Commit 3835b2b

Browse files
committed
docs: remove sphinx-related files and configure project for mkdocs
1 parent 7520f73 commit 3835b2b

17 files changed

+134
-180
lines changed

.readthedocs.yaml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
version: 2
2+
3+
build:
4+
os: ubuntu-22.04
5+
tools:
6+
python: "3.12"
7+
jobs:
8+
install:
9+
- pip install -r requirements-docs.txt
10+
11+
sphinx:
12+
configuration: docs/source/conf.py
13+
14+
mkdocs:
15+
configuration: mkdocs.yml

docs/Makefile

Lines changed: 0 additions & 20 deletions
This file was deleted.

docs/api.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Models
2+
3+
## YoloV7
4+
5+
::: aipose.models.yolov7

docs/frame_manager_availables.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Frame Manager
2+
3+
The Video Stream library uses OpenCV to read from various sources of video such as webcams, videos, or RTSP streams.
4+
5+
An example of the implementation can be found [here](https://github.com/Tlaloc-Es/aipose/blob/master/aipose/stream/__init__.py).
6+
7+
## Video Stream Lifecycle
8+
9+
To perform actions with a pose estimator, you need to build or call a `FrameManagerBase`.
10+
11+
When a video is being processed, there are three events that can be managed using a [`FrameManagerBase`](https://github.com/Tlaloc-Es/aipose/blob/master/aipose/frame/frame_manager_base.py):
12+
13+
- **stream_started**: This event is triggered when the video stream starts.
14+
- **before_read_frame**: This event is triggered before a frame is read from the video stream.
15+
- **frame_received**: This event is triggered for each frame read from the video stream.
16+
- **stream_ended**: This event is triggered when the video stream ends.
17+
18+
You can use these events to perform various actions such as initializing variables, preprocessing the frame, running inference, and displaying the result.
19+
20+
### Lifecycle Flowchart
21+
22+
```mermaid
23+
flowchart TD
24+
25+
stream_started --> before_read_frame
26+
before_read_frame --> frame_received
27+
frame_received --> before_read_frame
28+
frame_received --> stream_ended
29+
```
30+
31+
32+
<script>
33+
document.addEventListener("DOMContentLoaded", function() {
34+
mermaid.initialize({ startOnLoad: true });
35+
});
36+
</script>

docs/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Welcome to AIPOSE's Documentation
2+
3+
aipose is a Python library for using pose estimation easily in your Python project.
4+
5+
Check out the usage section for further information, including how to install the project.
6+
7+
Note: This project is under active development.

docs/make.bat

Lines changed: 0 additions & 35 deletions
This file was deleted.

docs/requirements.txt

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/source/api.rts

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/source/conf.py

Lines changed: 0 additions & 36 deletions
This file was deleted.

docs/source/frame_manager_availables.rst

Lines changed: 0 additions & 29 deletions
This file was deleted.

0 commit comments

Comments
 (0)