📝 [Add] Docs basic file and env

.readthedocs.yaml

@@ -1,32 +1,8 @@
-# .readthedocs.yaml
-# Read the Docs configuration file
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-
-# Required
 version: 2
 
-# Set the OS, Python version and other tools you might need
-build:
-  os: ubuntu-22.04
-  tools:
-    python: "3.12"
-    # You can also specify other tool versions:
-    # nodejs: "19"
-    # rust: "1.64"
-    # golang: "1.19"
-
-# Build documentation in the "docs/" directory with Sphinx
-# sphinx:
-#   configuration: docs/conf.py
-
-# Optionally build your docs in additional formats such as PDF and ePub
-# formats:
-#    - pdf
-#    - epub
+sphinx:
+  configuration: docs/conf.py
 
-# Optional but recommended, declare the Python requirements required
-# to build your documentation
-# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
-# python:
-#    install:
-#    - requirements: docs/requirements.txt
+python:
+  install:
+    - requirements: docs/requirements.txt

README.md

@@ -4,6 +4,7 @@
 ![WIP](https://img.shields.io/badge/status-WIP-orange)
 ![](https://img.shields.io/github/actions/workflow/status/WongKinYiu/YOLO/deploy.yaml)
 
+[![Documentation Status](https://readthedocs.org/projects/yolo-docs/badge/?version=latest)](https://yolo-docs.readthedocs.io/en/latest/?badge=latest)
 
 [![PWC](https://img.shields.io/endpoint.svg?url=https://paperswithcode.com/badge/yolov9-learning-what-you-want-to-learn-using/real-time-object-detection-on-coco)](https://paperswithcode.com/sota/real-time-object-detection-on-coco)
 

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,37 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "YOLO-docs"
+copyright = "2024, Kin-Yiu, Wong and Hao-Tang, Tsui"
+author = "Kin-Yiu, Wong and Hao-Tang, Tsui"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx_rtd_theme",
+    "myst_parser",
+]
+
+myst_enable_extensions = [
+    "dollarmath",
+    "amsmath",
+    "deflist",
+]
+html_theme = "sphinx_rtd_theme"
+
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_static_path = ["_static"]

docs/index.rst

@@ -0,0 +1,81 @@
+YOLO documentation
+=======================
+
+Introduction
+------------
+
+YOLO (You Only Look Once) is a state-of-the-art, real-time object detection system that is designed for both efficiency and accuracy. This documentation provides comprehensive guidance on how to set up, configure, and effectively use YOLO for object detection tasks.
+
+**Note: This project and some sections of this documentation are currently a work in progress.**
+
+Project Features
+----------------
+
+- **Real-time Processing**: YOLO can process images in real-time with high accuracy, making it suitable for applications that require instant detection.
+- **Multitasking Capabilities**: Our enhanced version of YOLO supports multitasking, allowing it to handle multiple object detection tasks simultaneously.
+- **Open Source**: YOLO is open source, released under the MIT License, encouraging a broad community of developers to contribute and build upon the existing framework.
+
+Documentation Contents
+----------------------
+
+Explore our documentation:
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Get Started
+
+   0_get_start/0_quick_start.md
+   0_get_start/1_installations.md
+   0_get_start/2_git.md
+   0_get_start/3_pypi.md
+   0_get_start/4_docker.md
+   0_get_start/5_conda.md
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Tutorials
+
+   1_tutorials/0_train.md
+   1_tutorials/1_validation.md
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Model Zoo
+
+   2_model_zoo/0_object_detection.md
+   2_model_zoo/1_segmentation.md
+   2_model_zoo/2_classification.md
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Custom YOLO
+
+   3_custom/0_model.md
+   3_custom/1_data_augment.md
+   3_custom/2_loss.md
+   3_custom/3_task.md
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Deploy
+
+   4_deploy/1_deploy.md
+   4_deploy/2_onnx.md
+   4_deploy/3_tensorrt.md
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Deploy
+
+   4_deploy/1_deploy.md
+   4_deploy/2_onnx.md
+   4_deploy/3_tensorrt.md
+
+License
+-------
+
+YOLO is provided under the MIT License, which allows extensive freedom for reuse and distribution. See the LICENSE file for full license text.

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/requirements.txt

@@ -0,0 +1,3 @@
+sphinx
+sphinx_rtd_theme
+myst-parser