DOC: update doc content && update sphinx to latest version (#809)

xorbitsai · Sep 6, 2024 · 9984250 · 9984250
1 parent 3eb3d37
commit 9984250
Show file tree

Hide file tree

Showing 16 changed files with 445 additions and 195 deletions.
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -21,13 +21,13 @@
  "sphinx.ext.githubpages",
  "sphinx.ext.autosummary",
  "sphinx.ext.napoleon",
- "IPython.sphinxext.ipython_directive",
- "IPython.sphinxext.ipython_console_highlighting",
+ # "IPython.sphinxext.ipython_directive",
+ # "IPython.sphinxext.ipython_console_highlighting",
  "matplotlib.sphinxext.plot_directive",
 ]
 
 templates_path = ["_templates"]
-exclude_patterns = []
+exclude_patterns = ['reference/numpy/*', 'reference/pandas/*']
 
 # i18n
 locale_dirs = ["locale/"] # path is example but recommended.
@@ -50,9 +50,6 @@
 # see https://stackoverflow.com/a/73497480
 if "zh_cn" not in tags.tags.keys():
  # en
- html_theme_options["external_links"] = [
- {"name": "xorbits.io", "url": "https://xorbits.io"},
- ]
  html_theme_options["icon_links"] = [
  {
  "name": "GitHub",

diff --git a/doc/source/getting_started/index.rst b/doc/source/getting_started/index.rst
@@ -8,8 +8,7 @@ Getting Started
 Use Xorbits to scale ML/DS workloads on your laptop or your own cluster.
 
 * Load and process datasets: :ref:`10min_pandas`
-* Scale machine learning workloads: coming soon
-* Deploy your own model: coming soon
+* Scale machine learning workloads: :ref:`xorbits_train_index`
 * Deploy to the cloud: :ref:`deployment`
 
 .. toctree::

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -44,8 +44,6 @@ Getting involved
  +--------------------------------------------------------------------------------------------------+----------------------------------------------------+
  | **Platform** | **Purpose** |
  +--------------------------------------------------------------------------------------------------+----------------------------------------------------+
- | `Discourse Forum <https://discuss.xorbits.io/>`_ | Asking usage questions and discussing development. |
- +--------------------------------------------------------------------------------------------------+----------------------------------------------------+
  | `Github Issues <https://github.com/xorbitsai/xorbits/issues>`_ | Reporting bugs and filing feature requests. |
  +--------------------------------------------------------------------------------------------------+----------------------------------------------------+
  | `Slack <https://join.slack.com/t/xorbitsio/shared_invite/zt-1o3z9ucdh-RbfhbPVpx7prOVdM1CAuxg>`_ | Collaborating with other Xorbits users. |
@@ -75,6 +73,5 @@ Getting involved
  getting_started/index
  libraries/index
  user_guide/index
- deployment/index
  reference/index
  development/index
diff --git a/doc/source/libraries/index.rst b/doc/source/libraries/index.rst
@@ -6,5 +6,3 @@ Libraries
 
  xorbits_data/index
  xorbits_train/index
- xorbits_tune/index
- xorbits_inference/index