Ast fork (#92)

Author: yichuan-w

.gitmodules

@@ -14,3 +14,7 @@
 [submodule "packages/leann-backend-hnsw/third_party/libzmq"]
 	path = packages/leann-backend-hnsw/third_party/libzmq
 	url = https://github.com/zeromq/libzmq.git
+[submodule "packages/astchunk-leann"]
+	path = packages/astchunk-leann
+	url = git@github.com:yichuan-w/astchunk-leann.git
+	branch = main

docs/ast_chunking_guide.md

@@ -26,6 +26,21 @@ leann build my-code-index --docs ./src --use-ast-chunking
 uv pip install -e "."
 ```
 
+#### For normal users (PyPI install)
+- Use `pip install leann` or `uv pip install leann`.
+- `astchunk` is pulled automatically from PyPI as a dependency; no extra steps.
+
+#### For developers (from source, editable)
+```bash
+git clone https://github.com/yichuan-w/LEANN.git leann
+cd leann
+git submodule update --init --recursive
+uv sync
+```
+- This repo vendors `astchunk` as a git submodule at `packages/astchunk-leann` (our fork).
+- `[tool.uv.sources]` maps the `astchunk` package to that path in editable mode.
+- You can edit code under `packages/astchunk-leann` and Python will use your changes immediately (no separate `pip install astchunk` needed).
+
 ## Best Practices
 
 ### When to Use AST Chunking

docs/grep_search.md

@@ -71,7 +71,7 @@ configs = searcher.search("server_port=", use_grep=True)
 ### Search Process
 
 ```
-Query: "def train_model" 
+Query: "def train_model"
   ↓
 grep -i -n "def train_model" documents.leann.passages.jsonl
   ↓
@@ -130,14 +130,14 @@ from leann.api import LeannSearcher
 def demonstrate_grep_search():
     # Initialize searcher
     searcher = LeannSearcher("my_index")
-    
+
     print("=== Function Search ===")
     functions = searcher.search("def __init__", use_grep=True, top_k=5)
     for i, result in enumerate(functions, 1):
         print(f"{i}. Score: {result.score}")
         print(f"   Preview: {result.text[:60]}...")
         print()
-    
+
     print("=== Error Search ===")
     errors = searcher.search("FileNotFoundError", use_grep=True, top_k=3)
     for result in errors:

packages/astchunk-leann

@@ -99,6 +99,7 @@ wechat-exporter = "wechat_exporter.main:main"
 leann-core = { path = "packages/leann-core", editable = true }
 leann-backend-diskann = { path = "packages/leann-backend-diskann", editable = true }
 leann-backend-hnsw = { path = "packages/leann-backend-hnsw", editable = true }
+astchunk = { path = "packages/astchunk-leann", editable = true }
 
 [tool.ruff]
 target-version = "py39"