Skip to content

Fix GitHub Pages build #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rookiewu417 merged 1 commit into from
Jun 7, 2026
Merged

Fix GitHub Pages build #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

### Added

- **示例报告：** 新增示例因子 `volume_return_corr_20d` 的真实 tear sheet（`docs/volume_return_corr_20d-tear-sheet.html`）与分区导读 README。
- **示例报告：** 新增示例因子 `volume_return_corr_20d` 的真实 tear sheet（`https://rookiewu417.github.io/FactorZen/volume_return_corr_20d-tear-sheet.html`）与分区导读 README。
- **示例因子：** 新增 `workspace/factors/daily/volume_return_corr_20d.py`（20 日量价滚动相关）及其配置，并在 factor-authoring 中作为进阶 worked example。
- **因子模板：** 各频率目录新增 `TEMPLATE.md` 手写模板，并在 factor-authoring 中引用。
- **测试加固：** 新增 `test_charts_helpers` / `test_summaries_helpers` 共 29 个边界单测，覆盖报告模块的 None / 空输入防御分支（`_charts` 78%→85%，`_summaries` 78%→81%）；覆盖率门槛 73%→74%。
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ pre-commit install
| [因子编写](docs/factor-authoring.md) | 因子放哪里、实现什么接口、如何验证 |
| [运行手册](docs/runbook.md) | 常用命令、报告入口、数据拉取、故障处理 |
| [演进计划](docs/evolution-plan-2026.md) | 公开路线图与非目标 |
| [示例报告](docs/volume_return_corr_20d-tear-sheet.html) | 真实 tear sheet 示例 |
| [示例报告](https://rookiewu417.github.io/FactorZen/volume_return_corr_20d-tear-sheet.html) | 真实 tear sheet 示例 |

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

Expand Down
1 change: 1 addition & 0 deletions docs/.nojekyll
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

2 changes: 1 addition & 1 deletion docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
| [factor-authoring](factor-authoring.md) | 因子作者 | 新因子放哪里、实现什么接口、如何验证 |
| [runbook](runbook.md) | 日常使用者、值守者 | 常用命令、报告入口、数据拉取、故障处理 |
| [evolution-plan-2026](evolution-plan-2026.md) | 维护者 | 公开路线图与非目标 |
| [示例报告](volume_return_corr_20d-tear-sheet.html) | 新用户、复核者 | 真实 tear sheet 示例 |
| [示例报告](https://rookiewu417.github.io/FactorZen/volume_return_corr_20d-tear-sheet.html) | 新用户、复核者 | 真实 tear sheet 示例 |
| [release-notes/](release-notes/) | 发布使用者 | 已发布版本的历史说明（发布后不回写）|

## 局部 README
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

| 文件 | 说明 |
|------|------|
| [`volume_return_corr_20d-tear-sheet.html`](../volume_return_corr_20d-tear-sheet.html) | 示例因子的完整 HTML 报告（自包含，约 1.1MB）|
| [`volume_return_corr_20d-tear-sheet.html`](https://rookiewu417.github.io/FactorZen/volume_return_corr_20d-tear-sheet.html) | 示例因子的完整 HTML 报告（自包含，约 1.1MB）|

> GitHub 源码浏览器不会内联渲染 HTML；GitHub Pages 会直接展示 `docs/` 根目录下的报告页面。

Expand Down
4 changes: 2 additions & 2 deletions docs/factor-authoring.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 因子编写

> [FactorZen](../README.md) · [文档](README.md) · [架构](architecture.md) · **因子编写** · [运行手册](runbook.md) · [示例报告](volume_return_corr_20d-tear-sheet.html)
> [FactorZen](../README.md) · [文档](README.md) · [架构](architecture.md) · **因子编写** · [运行手册](runbook.md) · [示例报告](https://rookiewu417.github.io/FactorZen/volume_return_corr_20d-tear-sheet.html)

日常研究因子写在 `workspace/factors/`（你的空间），框架代码写在 `src/factorzen/`。框架自带的示例/测试因子在 `src/factorzen/builtin_factors/`（随包分发）——注册表同时扫描两处，同名时 `workspace` 覆盖内置。**新增因子默认不要改 `src`。**

Expand Down Expand Up @@ -113,7 +113,7 @@ pixi run fz factor run volume_return_corr_20d --start 20160606 --end 20260606
pixi run fz report path <run_id>
```

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

要点（相对最小示例新增的）：

Expand Down
Loading