Update and improve documentation

numediart · Apr 10, 2024 · 4d1b365 · 4d1b365
1 parent 1adae5e
commit 4d1b365
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 38 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -68,8 +68,7 @@
 # remove some primary sidebar
 html_sidebars = {
  'getstarted': [], 
- 'vsensebox/vsense': [], 
- 'vsensebox/structure': [], 
+ 'vsensebox/vsense': [], 
  'vsensebox/config': [], 
  'vsensebox/utils': [], 
  'releasenotes': []

diff --git a/docs/index.rst b/docs/index.rst
@@ -5,6 +5,43 @@
 
 ----
 
+.. _structure:
+
+Structure of ``VSenseBox``
+==========================
+
+.. code-block:: text
+
+ vsensebox ............................ Root
+ ├───config ........................... Internal config directory
+ │ │ __init__.py
+ │ ├───detectors .................... Internal config directory for all detectors
+ │ │ *.yaml ................... Internal config files of supported detectors
+ │ ├───trackers ..................... Internal config directory for all trackers
+ │ │ *.yaml ................... Internal config file for supported trackers
+ │ └───strings
+ │ strings.yaml ............. Internal config file for unified strings
+ ├───data ............................. Internal data directory, vsensebox-data module
+ │ ├───datasets ..................... Directory for supported datasets 
+ │ ├───detectors .................... Directory for detectors' models/weights
+ │ ├───trackers ..................... Directory for trackers' models/weights
+ │ └───logs ......................... Directory for logs
+ ├───gui .............................. GUI module
+ ├───modules .......................... All supported modules
+ │ │ __init__.py
+ │ ├───detectors .................... All supported detectors
+ │ │ __init__.py
+ │ └───trackers ..................... All supported trackers
+ │ __init__.py
+ ├───vsense ........................... VSense
+ │ __init__.py
+ └───utils ............................ Utilities including visualization, etc.
+ __init__.py
+
+|
+
+----
+
 .. _tablecontents:
 
 Table of contents
@@ -16,7 +53,6 @@ Table of contents
  getstarted
  examples
  vsensebox/vsense
- vsensebox/structure
  vsensebox/modules
  vsensebox/config
  vsensebox/utils

diff --git a/docs/vsensebox/structure.rst b/docs/vsensebox/structure.rst