📝 [Update] docs by including autolabel and code

docs/0_get_start/0_quick_start.rst

@@ -5,6 +5,7 @@ Quick Start
    We expect all customizations to be done primarily by passing arguments or modifying the YAML config files.
    If more detailed modifications are needed, custom content should be modularized as much as possible to avoid extensive code modifications.
 
+.. _QuickInstallYOLO:
 Install YOLO
 ------------
 

docs/1_tutorials/1_validation.rst

@@ -1,5 +1,3 @@
-.. _Validation:
-
 Validation
 ==========
 

docs/1_tutorials/2_inference.rst

@@ -1,5 +1,3 @@
-.. _Inference:
-
 Inference
 ==========
 

docs/2_model_zoo/1_segmentation.rst

@@ -1,8 +1,11 @@
 Segmentations
 =============
+.. _YOLOv7-seg:
 
 YOLOv7
 ------
 
+.. _YOLOv9-seg:
+
 YOLOv9
 ------

docs/3_custom/0_model.rst

@@ -1,4 +1,2 @@
-.. _Model:
-
 Model
 =====

docs/3_custom/2_loss.rst

@@ -1,4 +1,2 @@
-.. _Loss:
-
 Loss
 ====

docs/3_custom/3_task.rst

@@ -1,4 +1,2 @@
-.. _Task:
-
-Task
-====
+Custom Task
+===========

docs/5_features/0_small_object.rst

@@ -1,4 +1,2 @@
-.. _Small Object:
-
 Small Object
 ============

docs/5_features/1_version_convert.rst

@@ -1,4 +1,2 @@
-.. _Version Convert:
-
 Version Convert
 ===============

docs/5_features/2_IPython.rst

@@ -1,4 +1,2 @@
-.. _IPython:
-
 IPython
 =======

docs/conf.py

@@ -19,8 +19,13 @@ import sys
 sys.path.insert(0, os.path.abspath(".."))
 
 extensions = [
-    "sphinx.ext.autodoc",
     "sphinx_rtd_theme",
+    "sphinxcontrib.mermaid",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosectionlabel",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.napoleon",
+    "linuxdoc.rstFlatTable",
     "myst_parser",
 ]
 

docs/index.rst

@@ -22,14 +22,14 @@ Explore our documentation:
 
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Get Started
 
    0_get_start/0_quick_start
    0_get_start/1_installations
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Tutorials
 
    1_tutorials/0_train
@@ -38,7 +38,7 @@ Explore our documentation:
 
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Model Zoo
 
    2_model_zoo/0_object_detection
@@ -46,7 +46,7 @@ Explore our documentation:
    2_model_zoo/2_classification
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Custom YOLO
 
    3_custom/0_model
@@ -56,7 +56,7 @@ Explore our documentation:
 
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Deploy
 
    4_deploy/1_deploy
@@ -65,7 +65,7 @@ Explore our documentation:
 
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Features
 
    5_features/0_small_object
@@ -73,7 +73,7 @@ Explore our documentation:
    5_features/2_IPython
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Function Docs
 
    6_function_docs/0_solver

docs/requirements.txt

@@ -1,3 +1,5 @@
+myst-parser
+linuxdoc
 sphinx
 sphinx_rtd_theme
-myst-parser
+sphinxcontrib-mermaid