新增文件

project_doc.rst

@@ -0,0 +1,93 @@
+==========================
+yield-smart-app 项目文档
+==========================
+
+:版本: 0.1.0
+:作者: 研发团队
+:日期: 2026-04-16
+
+.. contents:: 目录
+   :depth: 2
+   :local:
+
+项目概述
+========
+
+``yield-smart-app`` 是一个基于 **Streamlit** 构建的数据分析与可视化应用，
+旨在帮助用户快速上传、处理和分析多种格式的数据文件。
+
+支持的数据格式包括：
+
+- CSV / TSV
+- Excel (``.xlsx`` / ``.xls``)
+- JSON / JSONL
+- Parquet
+- HDF5
+- XML
+- YOLO 标注格式
+- 图片文件
+
+快速开始
+========
+
+环境准备
+--------
+
+确保已安装 Python 3.10+，然后执行：
+
+.. code-block:: bash
+
+   uv pip install -r requirements.txt
+
+启动应用
+--------
+
+.. code-block:: bash
+
+   streamlit run app.py --server.port 8000
+
+功能模块
+========
+
+数据上传模块
+------------
+
+用户可通过侧边栏上传文件，系统自动识别文件类型并进行初步解析。
+
+.. note::
+   当前单文件大小限制为 **200 MB**，超出限制请使用分片上传功能。
+
+数据预览模块
+------------
+
+上传成功后，系统会展示前 10 行数据，并提供列类型推断结果。
+
+.. warning::
+   若列类型推断不准确，用户可在高级设置中手动覆盖。
+
+可视化模块
+----------
+
+支持以下图表类型：
+
+1. 折线图（时间序列）
+2. 柱状图（分类对比）
+3. 散点图（相关性分析）
+4. 热力图（矩阵数据）
+
+更新日志
+========
+
+.. hlist::
+   :columns: 2
+
+   - v0.1.0：初始版本发布
+   - v0.1.1：新增 Parquet 支持
+   - v0.1.2：优化 UI 主题
+
+相关链接
+========
+
+- `项目仓库 <https://github.com/example/yield-smart-app>`_
+- `Issue 追踪 <https://github.com/example/yield-smart-app/issues>`_
+- `Streamlit 文档 <https://docs.streamlit.io/>`_