fix chinese doc bug (#883)

Author: wzh1994

.github/workflows/main.yml

@@ -76,8 +76,10 @@ jobs:
       - name: Run DocCheck
         run: |
           pip install -r tests/requirements.txt
-          pytest --lf --durations=0 -v tests/doc_check
-          LAZYLLM_LANGUAGE=CHINESE pytest --lf --durations=0 -v tests/doc_check
+          pytest -v tests/doc_check
+          git checkout .
+          LAZYLLM_LANGUAGE=CHINESE pytest -v tests/doc_check
+          git checkout .
 
   clone:
     if: |

lazyllm/docs/common.py

@@ -62,6 +62,15 @@
     group_name (str): The name of the group to be created.
 ''')
 
+
+add_chinese_doc('Register.new_group', '''\
+创建一个新的ComponentGroup。新建的group会自动加入到__builtin__中，无需import即可在任一位置访问到该group。
+
+Args:
+    group_name (str): 待创建的group的名字
+''')
+
+
 # add_example('Register', '''\
 # >>> import lazyllm
 # >>> @lazyllm.component_register('mygroup')

lazyllm/docs/utils.py

@@ -3,6 +3,9 @@
 import threading
 from typing import Tuple
 
+lazyllm.config.add('raise_on_add_doc_error', bool, False, 'RAISE_ON_ADD_DOC_ERROR',
+                   description='Whether to raise an error when adding doc failed.')
+
 cpp_add_doc_code = '''
 namespace py = pybind11;
 void addDocStr(py::object obj, std::string docs) {
@@ -91,7 +94,8 @@ def add_doc(obj_name, docstr, module, append=''):
         else:
             obj.__doc__ = docstr
     except Exception:
-        raise NotImplementedError('Cannot add doc for builtin class or method now, will be supported in the feature')
+        if lazyllm.config['raise_on_add_doc_error']:
+            raise RuntimeError(f'Failed to add doc for {obj_name} in {module.__name__}')
 
 
 def add_chinese_doc(obj_name, docstr, module=lazyllm):