orgnize doc

Author: eddyxu

docs/conf.py

@@ -68,7 +68,7 @@ def setup(app):
 html_static_path = ["_static"]
 
 html_favicon = "_static/favicon_64x64.png"
-# html_logo = "_static/high-res-icon.png"
+html_logo = "_static/high-res-icon.png"
 html_theme_options = {
     "icon": {
         "repo": "fontawesome/brands/github",
@@ -77,7 +77,12 @@ def setup(app):
     "site_url": "https://github.com/lancedb/lance",
     "repo_url": "https://github.com/lancedb/lance",
     "repo_name": "Lance",
-
+    "features": [
+        "navigation.expand",
+        # "navigation.tabs",
+        "content.tabs.link",
+        "content.code.copy",
+    ],
     "social": [
         {
             "icon": "fontawesome/brands/github",

docs/index.rst

@@ -39,7 +39,7 @@ Preview releases receive the same level of testing as regular releases.
 
 
 .. toctree::
-   :caption: Quickstart
+   :caption: Introduction
    :maxdepth: 2
 
    Quickstart <./notebooks/quickstart>

docs/tokenizer.rst

@@ -14,24 +14,25 @@ It also supports configuring user dictionaries,
 which makes it convenient for users to expand their own dictionaries without retraining the language models.
 
 Language Models of Jieba
----------------
+------------------------
 
 Downloading the Model
-~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~
 
 .. code-block:: bash
+
     python -m lance.download jieba
 
 The language model is stored by default in `${LANCE_LANGUAGE_MODEL_HOME}/jieba/default`.
 
 Using the Model
-~~~~~~~~~~~
+~~~~~~~~~~~~~~~
 
 .. code-block:: python
     ds.create_scalar_index("text", "INVERTED", base_tokenizer="jieba/default")
 
 User Dictionaries
-~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~
 Create a file named config.json in the root directory of the current model.
 
 .. code-block:: json
@@ -46,10 +47,10 @@ Create a file named config.json in the root directory of the current model.
 
 
 Language Models of Lindera
----------------
+--------------------------
 
 Downloading the Model
-~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~
 
 .. code-block:: bash
 
@@ -60,14 +61,14 @@ Note that the language models of Lindera need to be compiled. Please install lin
 The language model is stored by default in ${LANCE_LANGUAGE_MODEL_HOME}/lindera/[ipadic|ko-dic|unidic]
 
 Using the Model
-~~~~~~~~~~~
+~~~~~~~~~~~~~~~
 
 .. code-block:: python
 
     ds.create_scalar_index("text", "INVERTED", base_tokenizer="lindera/ipadic")
 
 User Dictionaries
-~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~
 
 Create a file named config.json in the root directory of the current model.
 
@@ -84,7 +85,7 @@ Create a file named config.json in the root directory of the current model.
 
 
 Create your own language model
----------------
+------------------------------
 
 Put your language model into `LANCE_LANGUAGE_MODEL_HOME`.