新增文件

basic.rst

@@ -0,0 +1,46 @@
+===============
+基础文档示例
+===============
+
+这是 reStructuredText（RST）格式的基本示例文档。
+
+章节标题
+========
+
+RST 使用下划线来标记标题层级，常见的标记符号包括：
+``=``、``-``、``~``、``^``、``"`` 等。
+
+小节节标题
+-----------
+
+这里是小节内容。RST 支持多种内联标记，如 **粗体**、*斜体*、`行内代码` 等。
+
+列表示例
+--------
+
+无序列表：
+
+- 第一项
+- 第二项
+  - 嵌套项 A
+  - 嵌套项 B
+- 第三项
+
+有序列表：
+
+1. 第一步
+2. 第二步
+3. 第三步
+
+引用与链接
+----------
+
+> 这是一段引用文本，通常用于引用他人的话语或重要提示。
+
+访问 `Python 官方网站 <https://www.python.org/>`_ 获取更多信息。
+
+也可以这样定义链接：
+
+`Sphinx 文档`_ 是学习 RST 的好资源。
+
+.. _Sphinx 文档: https://www.sphinx-doc.org/

code_api.rst

@@ -0,0 +1,92 @@
+======================
+代码与 API 文档示例
+======================
+
+本节演示如何在 RST 中展示代码块和 API 文档。
+
+代码块
+======
+
+Python 示例：
+
+.. code-block:: python
+   :linenos:
+   :caption: 训练模型示例
+
+   import torch
+   import torch.nn as nn
+
+   class SimpleNet(nn.Module):
+       def __init__(self, num_classes=10):
+           super().__init__()
+           self.fc = nn.Linear(784, num_classes)
+
+       def forward(self, x):
+           return self.fc(x.view(x.size(0), -1))
+
+Shell 示例：
+
+.. code-block:: bash
+
+   $ pip install sphinx rst2pdf
+   $ sphinx-quickstart docs/
+
+JSON 示例：
+
+.. code-block:: json
+
+   {
+     "name": "yield-smart-app",
+     "version": "0.1.0",
+     "dependencies": {
+       "streamlit": "^1.28",
+       "pandas": "^2.0"
+     }
+   }
+
+API 文档
+========
+
+函数文档
+--------
+
+.. function:: compute_yield(data, method="linear", verbose=False)
+   :noindex:
+
+   计算给定数据集的产量预测值。
+
+   :param data: 输入数据集，形状为 ``(N, D)`` 的数组或 DataFrame
+   :type data: numpy.ndarray or pandas.DataFrame
+   :param str method: 插值方法，可选 ``"linear"``、``"cubic"`` 或 ``"spline"``
+   :param bool verbose: 是否打印调试信息
+   :return: 产量预测结果
+   :rtype: numpy.ndarray
+   :raises ValueError: 当 ``data`` 为空或包含非法值时抛出
+
+类文档
+------
+
+.. class:: DataLoader(source, batch_size=32, shuffle=True)
+   :noindex:
+
+   数据加载器类。
+
+   .. attribute:: source
+      :type: str
+
+      数据源路径或 URL。
+
+   .. attribute:: batch_size
+      :type: int
+
+      每批加载的样本数量。
+
+   .. method:: __iter__()
+      :noindex:
+
+      返回批次迭代器。
+
+   .. method:: reset()
+      :noindex:
+
+      重置内部状态，重新打乱数据顺序（如果 ``shuffle=True``）。

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/>`_

tables.rst

@@ -0,0 +1,64 @@
+==================
+表格数据示例
+==================
+
+以下是几种在 RST 中创建表格的方式。
+
+简单表格
+========
+
+=====  =====  =======
+输入A  输入B  输出
+=====  =====  =======
+0      0      0
+0      1      1
+1      0      1
+1      1      0
+=====  =====  =======
+
+网格表格
+========
+
++------------+------------+-----------+
+| 名称       | 类型       | 默认值    |
++============+============+===========+
+| lr         | float      | 1e-3      |
++------------+------------+-----------+
+| batch_size | int        | 32        |
++------------+------------+-----------+
+| epochs     | int        | 100       |
++------------+------------+-----------+
+| optimizer  | str        | "adam"    |
++------------+------------+-----------+
+
+CSV 表格
+========
+
+.. csv-table:: 产品信息表
+   :header: "产品ID", "产品名称", "价格", "库存"
+   :widths: 10, 30, 10, 10
+
+   P001, 无线鼠标, 99.00, 120
+   P002, 机械键盘, 299.00, 45
+   P003, 降噪耳机, 899.00, 20
+   P004, 4K 显示器, 1999.00, 8
+
+列表表格
+========
+
+.. list-table:: 项目成员表
+   :widths: 15 25 40
+   :header-rows: 1
+
+   * - 工号
+     - 姓名
+     - 职责
+   * - E001
+     - 张三
+     - 后端开发 / API 设计
+   * - E002
+     - 李四
+     - 前端开发 / UI 实现
+   * - E003
+     - 王五
+     - 测试 / DevOps