📝 Update documentation structure

- Remove usage.rst
- Rename Jupyter Notebooks to Usage Examples
- Show README for Usage Examples instead of TOC.
- Reduce TOC depth for basic functionalities and pipelines

Author: shaneahmed

docs/basic_functionalities.rst

@@ -2,7 +2,7 @@ Basic Functionalities
 *********************
 
 .. toctree::
-    :maxdepth: 2
+    :maxdepth: 1
     :glob:
 
     _notebooks/jnb/*

docs/conf.py

@@ -2016,8 +2016,8 @@ def all_but_ipynb(dir_path, contents):
 # Replace the target string
 file_data = file_data.replace(".rst", ".html")
 file_data = file_data.replace(".ipynb", ".html")
-file_data = file_data.replace("../docs/", "../")
 file_data = file_data.replace("](./", "](./jnb/")
+file_data = file_data.replace("../docs/", "./")
 
 # Write the file out again
 with open("_notebooks/README.md", "w") as file:

docs/index.rst

@@ -9,9 +9,8 @@ Welcome to TIA Toolbox's documentation!
 
     Readme <readme.rst>
     Installation <installation.rst>
-    Usage <usage.rst>
     Pre-trained Models <pretrained.rst>
-    Jupyter Notebooks <notebooks.rst>
+    Usage Examples <notebooks.rst>
     Algorithms <algorithms.rst>
     Visualization <visualization.rst>
     API Reference <_autosummary/tiatoolbox>

docs/jnb_pipelines.rst

@@ -2,7 +2,7 @@ Pipelines
 *********
 
 .. toctree::
-    :maxdepth: 2
+    :maxdepth: 1
     :glob:
 
     _notebooks/jnb/inference-pipelines/*

docs/notebooks.rst

@@ -4,23 +4,16 @@ Jupyter Notebooks
 .. include:: _notebooks/README.md
    :parser: myst_parser.sphinx_
 
-.. toctree::
-    :maxdepth: 1
-
-    _notebooks/README.md
-
 |
 
 .. toctree::
     :maxdepth: 2
-    :glob:
 
     Basic Functionalities <basic_functionalities.rst>
 
 |
 
 .. toctree::
     :maxdepth: 2
-    :glob:
 
     Pipelines <jnb_pipelines.rst>