Skip to content

Commit 45159a8

Browse files
committed
Move example report for GitHub Pages
1 parent 25fa3c8 commit 45159a8

6 files changed

Lines changed: 7 additions & 7 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626

2727
### Added
2828

29-
- **示例报告:** 新增 `docs/examples/`,收录示例因子 `volume_return_corr_20d` 的真实 tear sheet(`docs/examples/volume_return_corr_20d-tear-sheet.html`)与分区导读 README。
29+
- **示例报告:** 新增示例因子 `volume_return_corr_20d` 的真实 tear sheet(`docs/volume_return_corr_20d-tear-sheet.html`)与分区导读 README。
3030
- **示例因子:** 新增 `workspace/factors/daily/volume_return_corr_20d.py`(20 日量价滚动相关)及其配置,并在 factor-authoring 中作为进阶 worked example。
3131
- **因子模板:** 各频率目录新增 `TEMPLATE.md` 手写模板,并在 factor-authoring 中引用。
3232
- **测试加固:** 新增 `test_charts_helpers` / `test_summaries_helpers` 共 29 个边界单测,覆盖报告模块的 None / 空输入防御分支(`_charts` 78%→85%,`_summaries` 78%→81%);覆盖率门槛 73%→74%。

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ pre-commit install
187187
| [因子编写](docs/factor-authoring.md) | 因子放哪里、实现什么接口、如何验证 |
188188
| [运行手册](docs/runbook.md) | 常用命令、报告入口、数据拉取、故障处理 |
189189
| [演进计划](docs/evolution-plan-2026.md) | 公开路线图与非目标 |
190-
| [示例报告](docs/examples/) | 真实 tear sheet 示例与分区导读 |
190+
| [示例报告](docs/volume_return_corr_20d-tear-sheet.html) | 真实 tear sheet 示例 |
191191

192192
文档索引见 [docs/README.md](docs/README.md)
193193

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
| [factor-authoring](factor-authoring.md) | 因子作者 | 新因子放哪里、实现什么接口、如何验证 |
1515
| [runbook](runbook.md) | 日常使用者、值守者 | 常用命令、报告入口、数据拉取、故障处理 |
1616
| [evolution-plan-2026](evolution-plan-2026.md) | 维护者 | 公开路线图与非目标 |
17-
| [examples/](examples/) | 新用户、复核者 | 真实 tear sheet 示例与分区导读 |
17+
| [示例报告](volume_return_corr_20d-tear-sheet.html) | 新用户、复核者 | 真实 tear sheet 示例 |
1818
| [release-notes/](release-notes/) | 发布使用者 | 已发布版本的历史说明(发布后不回写)|
1919

2020
## 局部 README

docs/examples/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88

99
| 文件 | 说明 |
1010
|------|------|
11-
| [`volume_return_corr_20d-tear-sheet.html`](volume_return_corr_20d-tear-sheet.html) | 示例因子的完整 HTML 报告(自包含,约 1.1MB)|
11+
| [`volume_return_corr_20d-tear-sheet.html`](../volume_return_corr_20d-tear-sheet.html) | 示例因子的完整 HTML 报告(自包含,约 1.1MB)|
1212

13-
> GitHub 不会内联渲染 HTML。请点开后下载用浏览器打开,或借助 htmlpreview 类工具在线预览
13+
> GitHub 源码浏览器不会内联渲染 HTML;GitHub Pages 会直接展示 `docs/` 根目录下的报告页面
1414
1515
## 示例因子
1616

docs/factor-authoring.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 因子编写
22

3-
> [FactorZen](../README.md) · [文档](README.md) · [架构](architecture.md) · **因子编写** · [运行手册](runbook.md) · [示例报告](examples/)
3+
> [FactorZen](../README.md) · [文档](README.md) · [架构](architecture.md) · **因子编写** · [运行手册](runbook.md) · [示例报告](volume_return_corr_20d-tear-sheet.html)
44
55
日常研究因子写在 `workspace/factors/`(你的空间),框架代码写在 `src/factorzen/`。框架自带的示例/测试因子在 `src/factorzen/builtin_factors/`(随包分发)——注册表同时扫描两处,同名时 `workspace` 覆盖内置。**新增因子默认不要改 `src`**
66

@@ -113,7 +113,7 @@ pixi run fz factor run volume_return_corr_20d --start 20160606 --end 20260606
113113
pixi run fz report path <run_id>
114114
```
115115

116-
它产出的真实 tear sheet 已收录为示例报告:[docs/examples/](examples/)。该因子预测能力偏弱,正好演示报告如何诚实暴露「统计显著但经济意义弱」的结论——这是 FactorZen 的设计取向,而非缺陷。
116+
它产出的真实 tear sheet 已收录为示例报告:[docs/volume_return_corr_20d-tear-sheet.html](volume_return_corr_20d-tear-sheet.html)。该因子预测能力偏弱,正好演示报告如何诚实暴露「统计显著但经济意义弱」的结论——这是 FactorZen 的设计取向,而非缺陷。
117117

118118
要点(相对最小示例新增的):
119119

File renamed without changes.

0 commit comments

Comments
 (0)