Metadata-Version: 2.1
Name: apidoc2
Version: 0.1.2
Summary: 从Java项目批量提取ApiDoc注解并生成API文档的工具
Home-page: https://gitlab-code.howbuy.pa/ftx/apidoc-ext
Author: meng.lv
Author-email: meng.lv@howbuy.com
License: UNKNOWN
Description: # apidoc2
        
        一个用于从Java项目中批量提取ApiDoc注解并生成API文档的Python工具，支持多版本对比和自动生成apidoc文档。
        
        ## 功能简介
        
        - 支持从指定Git仓库克隆Java项目，提取所有Java文件中的ApiDoc注解
        - 支持多版本API文档对比，输出差异统计
        - 自动生成apidoc格式文档，便于前端/后端协作
        - 支持命令行参数自定义仓库、版本、输出文件名等
        
        ## 安装方法
        
        推荐使用pip安装（需先打包上传到PyPI）：
        
        ```bash
        pip install extract-apidoc
        ```
        
        或本地安装：
        
        ```bash
        git clone <your_repo_url>
        cd extract_apidoc
        pip install .
        ```
        
        ## 使用说明
        
        ### 基本用法
        
        ```bash
        python3 extract_apidoc.py -r <git仓库地址> -v1 <当前版本号> [-v2 <对比版本号>] [-o <输出文件名>]
        ```
        
        ### 参数说明
        
        - `-r, --repourl`：Git仓库地址（必填）
        - `-v1, --version1`：当前版本号或分支名（必填）
        - `-v2, --version2`：对比的历史版本号或分支名（可选）
        - `-o, --output`：输出文件名（可选，默认为output）
        
        ### 示例
        
        1. 只提取当前版本API文档：
           ```bash
           python3 extract_apidoc.py -r https://your.git.repo/project.git -v1 master
           ```
        2. 对比两个版本API文档差异：
           ```bash
           python3 extract_apidoc.py -r https://your.git.repo/project.git -v1 master -v2 develop
           ```
        
        ### 依赖
        
        - Python 3.6+
        - git
        - apidoc（需全局安装，`npm install -g apidoc`）
        
        ### 贡献
        
        欢迎提交PR或issue改进本工具。
        
        ### License
        
        MIT
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
