更新版本至 1.1.8，修复文档文件删除逻辑并优化用户提示信息

Author: zhangshulin

docapi/docapi.py

@@ -233,7 +233,7 @@ def _write_doc(self, doc_dir, structures):
         doc_json_path.unlink(missing_ok=True)
 
         for doc_file in doc_dir.glob('*.md'):
-            if doc_file.name == 'index.md':
+            if (doc_file.name == 'index.md') or (doc_file.suffix != '.md'):
                 continue
             doc_file.unlink()
 

docapi/main.py

@@ -9,7 +9,7 @@
 from docapi.docapi import DocAPI
 
 
-VERSION = '1.1.7'
+VERSION = '1.1.8'
 
 
 class Main:
@@ -40,7 +40,7 @@ def generate(app_path, doc_dir='docs', model=None, lang='zh', template=None, env
 
         doc_dir = Path(doc_dir)
         if doc_dir.exists():
-            user = input(f'The `{doc_dir.name}` directory already exists. Do you want to overwrite it? (y/n) ')
+            user = input(f'The `{doc_dir.name}` directory already exists. Do you want to overwrite it? (y/n): ')
             print()
             if user.lower() != 'y':
                 sys.exit(0)
@@ -81,14 +81,14 @@ def update(app_path, doc_dir='docs', model=None, lang='zh', template=None, env='
         if not doc_dir.is_dir():
             raise ValueError(f'Doc directory does not exist: `{doc_dir.name}`')
 
-        user = input(f'Updating the documentation will first clear the `./docs` folder. Do you want to continue? (y/n) ')
+        user = input(f'Updating the documentation will first remove the API files in `{doc_dir.name}` folder.\nDo you want to continue? (y/n): ')
         print()
         if user.lower() != 'y':
             sys.exit(0)
 
         model = model or os.getenv('DOCAPI_MODEL')
         if not model:
-            raise ValueError('Missing model parameter. Either pass it as an argument or set the DOCAPI_MODEL environment variable. Example: --model=openai:gpt-4o-mini.')
+            raise ValueError('Missing model parameter. Either pass it as an argument or set the DOCAPI_MODEL environment variable. Example: --model openai:gpt-4o-mini.')
 
         docapi = DocAPI.build(model, lang, template, workers, static)
         docapi.update(app_path, doc_dir)

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "docapi"
-version = "1.1.7"
+version = "1.1.8"
 description = "DocAPI is a Python package that automatically generates API documentation using LLMs. It currently supports Flask and Django frameworks."
 authors = ["zhangshulin <zhangslwork@yeah.net>"]
 license = "Apache-2.0"