[doc] move current toc out of readthedocs landingpage (#5201)

* remove toc from landing page

* update extension version

* resolve version conflict

* remove toc in page

* fix toc

* fix toc

* revise toc

* revise toc

* revise toc

* revise toc

* revise toc

* revise toc

* revise toc

* revise toc

* revise toc

docs/readthedocs/requirements-doc.txt

@@ -5,7 +5,6 @@ sphinx-jsonschema==1.19.1
 sphinxemoji==0.2.0
 click==8.1.3
 markdown<3.4
-tensorflow==1.15.2
 bigdl==0.12.0
 cloudpickle==2.1.0
 ray[tune]==1.9.2
@@ -16,7 +15,7 @@ setuptools==41.0.1
 docutils==0.17
 mock==1.0.1
 pillow==5.4.1
-sphinx==5.0.2
+sphinx==4.5.0
 alabaster>=0.7,<0.8,!=0.7.5
 commonmark==0.8.1
 recommonmark==0.5.0
@@ -35,3 +34,5 @@ protobuf~=3.19.0
 sphinx-tabs==3.4
 optuna==2.10.0
 ConfigSpace==0.5.0
+sphinx-design==0.2.0
+sphinx-external-toc==0.3.0

docs/readthedocs/source/_toc.yml

@@ -0,0 +1,102 @@
+root: index
+subtrees:
+  - caption: Quick Start
+    entries:
+      - file: doc/Orca/QuickStart/orca-tf-quickstart
+      - file: doc/Orca/QuickStart/orca-keras-quickstart
+      - file: doc/Orca/QuickStart/orca-tf2keras-quickstart
+      - file: doc/Orca/QuickStart/orca-pytorch-quickstart
+      - file: doc/Ray/QuickStart/ray-quickstart
+
+  - caption: User Guide
+    entries:
+      - file: doc/UserGuide/python
+      - file: doc/UserGuide/scala
+      - file: doc/UserGuide/colab
+      - file: doc/UserGuide/docker
+      - file: doc/UserGuide/hadoop
+      - file: doc/UserGuide/k8s
+      - file: doc/UserGuide/databricks
+      - file: doc/UserGuide/develop
+
+  - caption: Nano
+    entries:
+      - file: doc/Nano/Overview/nano
+      - file: doc/Nano/Overview/windows_guide
+      - file: doc/Nano/QuickStart/pytorch_train
+      - file: doc/Nano/QuickStart/pytorch_inference
+      - file: doc/Nano/QuickStart/tensorflow_train
+      - file: doc/Nano/QuickStart/tensorflow_inference
+      - file: doc/Nano/QuickStart/hpo
+      - file: doc/Nano/Overview/known_issues
+      - file: doc/Nano/QuickStart/index
+
+  - caption: DLlib
+    entries:
+      - file: doc/DLlib/Overview/dllib
+      - file: doc/DLlib/Overview/keras-api
+      - file: doc/DLlib/Overview/nnframes
+
+  - caption: Orca
+    entries:
+      - file: doc/Orca/Overview/orca
+        title: "Orca User Guide"
+      - file: doc/Orca/Overview/orca-context
+      - file: doc/Orca/Overview/data-parallel-processing
+      - file: doc/Orca/Overview/distributed-training-inference
+      - file: doc/Orca/Overview/distributed-tuning
+      - file: doc/Ray/Overview/ray
+      - file: doc/Orca/Overview/known_issues
+
+  - caption: Chronos
+    entries:
+      - file: doc/Chronos/Overview/chronos
+      - file: doc/Chronos/Overview/deep_dive
+      - file: doc/Chronos/QuickStart/index
+      - file: doc/Chronos/Overview/chronos_known_issue
+
+
+  - caption: PPML
+    entries:
+      - file: doc/PPML/Overview/ppml
+      - file: doc/PPML/Overview/trusted_big_data_analytics_and_ml
+      - file: doc/PPML/Overview/trusted_fl
+      - file: doc/PPML/QuickStart/secure_your_services
+      - file: doc/PPML/QuickStart/build_kernel_with_sgx
+      - file: doc/PPML/QuickStart/deploy_intel_sgx_device_plugin_for_kubernetes
+      - file: doc/PPML/QuickStart/trusted-serving-on-k8s-guide
+      - file: doc/PPML/QuickStart/tpc-h_with_sparksql_on_k8s
+      - file: doc/PPML/QuickStart/tpc-ds_with_sparksql_on_k8s
+      - file: doc/PPML/Overview/azure_ppml
+
+  - caption: Serving
+    entries:
+      - file: doc/Serving/Overview/serving.md
+      - file: doc/Serving/QuickStart/serving-quickstart
+      - file: doc/Serving/ProgrammingGuide/serving-installation
+      - file: doc/Serving/ProgrammingGuide/serving-start
+      - file: doc/Serving/ProgrammingGuide/serving-inference
+      - file: doc/Serving/Example/example
+      - file: doc/Serving/FAQ/faq
+      - file: doc/Serving/FAQ/contribute-guide
+
+  - caption: Common Use Case
+    entries:
+      - file: doc/Orca/QuickStart/orca-pytorch-distributed-quickstart
+      - file: doc/UseCase/spark-dataframe
+      - file: doc/UseCase/xshards-pandas
+      - file: doc/Orca/QuickStart/orca-autoestimator-pytorch-quickstart
+      - file: doc/Orca/QuickStart/orca-autoxgboost-quickstart
+
+  - caption: Python API
+    entries:
+      - file: doc/PythonAPI/Orca/orca
+      - file: doc/PythonAPI/Friesian/feature
+      - file: doc/PythonAPI/Chronos/index
+      - file: doc/PythonAPI/Nano/index
+
+  - caption: Real-World Application
+    entries:
+      - file: doc/Application/presentations
+      - file: doc/Application/blogs
+      - file: doc/Application/powered-by

docs/readthedocs/source/conf.py

@@ -18,7 +18,7 @@ import glob
 import shutil
 import urllib
 
-autodoc_mock_imports = ["openvino", "pytorch_lightning", "keras"]
+autodoc_mock_imports = ["openvino", "pytorch_lightning", "keras", "tensorflow"]
 
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #sys.path.insert(0, '.')
@@ -90,6 +90,8 @@ extensions = [
     'recommonmark',
     'sphinx_markdown_tables',
     'sphinx_tabs.tabs',
+    'sphinx_design',
+    'sphinx_external_toc',
 ]
 
 
@@ -152,6 +154,14 @@ html_static_path = ['_static']
 htmlhelp_basename = 'BigDL Documentation'
 
 
+
+# -- Options for external TOC tree ---
+external_toc_exclude_missing = False
+external_toc_path = "_toc.yml"
+
+# this is to surpresswarnings about explicit "toctree" directives
+suppress_warnings = ["etoc.toctree"]
+
 # -- Options for LaTeX output ------------------------------------------------
 
 latex_elements = {

docs/readthedocs/source/index.rst

@@ -16,125 +16,3 @@ BigDL Documentation
 
 .. meta::
    :google-site-verification: hG9ocvSRSRTY5z8g6RLn97_tdJvYRx_tVGhNdtZZavM
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Quick Start
-
-   doc/Orca/QuickStart/orca-tf-quickstart.md
-   doc/Orca/QuickStart/orca-keras-quickstart.md
-   doc/Orca/QuickStart/orca-tf2keras-quickstart.md
-   doc/Orca/QuickStart/orca-pytorch-quickstart.md
-   doc/Ray/QuickStart/ray-quickstart.md
-
-.. toctree::
-   :maxdepth: 1
-   :caption: User Guide
-
-   doc/UserGuide/python.md
-   doc/UserGuide/scala.md
-   doc/UserGuide/colab.md
-   doc/UserGuide/docker.md
-   doc/UserGuide/hadoop.md
-   doc/UserGuide/k8s.md
-   doc/UserGuide/databricks.md
-   doc/UserGuide/develop.md
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Nano Overview
-
-   doc/Nano/Overview/nano.md
-   doc/Nano/Overview/windows_guide.md
-   doc/Nano/QuickStart/pytorch_train.md
-   doc/Nano/QuickStart/pytorch_inference.md
-   doc/Nano/QuickStart/tensorflow_train.md
-   doc/Nano/QuickStart/tensorflow_inference.md
-   doc/Nano/QuickStart/hpo.rst
-   doc/Nano/Overview/known_issues.md
-   doc/Nano/QuickStart/index.md
-
-.. toctree::
-   :maxdepth: 1
-   :caption: DLlib Overview
-
-   doc/DLlib/Overview/dllib.md
-   doc/DLlib/Overview/keras-api.md
-   doc/DLlib/Overview/nnframes.md
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Orca Overview
-
-   doc/Orca/Overview/orca.md
-   doc/Orca/Overview/orca-context.md
-   doc/Orca/Overview/data-parallel-processing.md
-   doc/Orca/Overview/distributed-training-inference.md
-   doc/Orca/Overview/distributed-tuning.md
-   doc/Ray/Overview/ray.md
-   doc/Orca/Overview/known_issues.md
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Chronos Overview
-
-   doc/Chronos/Overview/chronos.md
-   doc/Chronos/Overview/deep_dive.rst
-   doc/Chronos/QuickStart/index.md
-   doc/Chronos/Overview/chronos_known_issue.md
-
-.. toctree::
-   :maxdepth: 1
-   :caption: PPML Overview
-
-   doc/PPML/Overview/ppml.md
-   doc/PPML/Overview/trusted_big_data_analytics_and_ml.md
-   doc/PPML/Overview/trusted_fl.md
-   doc/PPML/QuickStart/secure_your_services.md
-   doc/PPML/QuickStart/build_kernel_with_sgx.md
-   doc/PPML/QuickStart/deploy_intel_sgx_device_plugin_for_kubernetes.md
-   doc/PPML/QuickStart/trusted-serving-on-k8s-guide.md
-   doc/PPML/QuickStart/tpc-h_with_sparksql_on_k8s.md
-   doc/PPML/QuickStart/tpc-ds_with_sparksql_on_k8s.md
-   doc/PPML/Overview/azure_ppml.md
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Serving Overview
-
-   doc/Serving/Overview/serving.md
-   doc/Serving/QuickStart/serving-quickstart.md
-   doc/Serving/ProgrammingGuide/serving-installation.md
-   doc/Serving/ProgrammingGuide/serving-start.md
-   doc/Serving/ProgrammingGuide/serving-inference.md
-   doc/Serving/Example/example.md
-   doc/Serving/FAQ/faq.md
-   doc/Serving/FAQ/contribute-guide.md
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Common Use Case
-
-   doc/Orca/QuickStart/orca-pytorch-distributed-quickstart.md
-   doc/UseCase/spark-dataframe.md
-   doc/UseCase/xshards-pandas.md
-   doc/Orca/QuickStart/orca-autoestimator-pytorch-quickstart.md
-   doc/Orca/QuickStart/orca-autoxgboost-quickstart.md
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Python API
-
-   doc/PythonAPI/Orca/orca.rst
-   doc/PythonAPI/Friesian/feature.rst
-   doc/PythonAPI/Chronos/index.rst
-   doc/PythonAPI/Nano/index.rst
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Real-World Application
-
-   doc/Application/presentations.md
-   doc/Application/blogs.md
-   doc/Application/powered-by.md
-