Skip to content

Commit 4629b45

Browse files
yutiansutyutiansut
committed
feat: 更新README和文档以增强用户体验和信息可用性
- 在README.md中添加项目联系方式、QABook技术文档链接和版权信息，提升文档的完整性和可读性。 - 在doc/README.md和doc/SUMMARY.md中引入QABook相关内容，提供PDF技术手册的下载和编译指南，方便用户获取技术支持。 - 更新LaTeX配置文件以反映最新版本信息，确保文档与项目版本一致。 此更新旨在提升用户对项目的理解和使用体验。
1 parent 90bd5dc commit 4629b45

File tree

10 files changed

+1497
-46
lines changed

10 files changed

+1497
-46
lines changed

‎.github/workflows/qabook-build.yml‎

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
# QUANTAXIS QABook PDF自动编译与发布
2+
#
3+
# 功能说明:
4+
# - 当qabook/目录有更新时自动触发
5+
# - 使用XeLaTeX编译生成PDF
6+
# - 自动发布到GitHub Releases
7+
#
8+
# 作者: @yutiansut @quantaxis
9+
# 更新日期: 2025-10-25
10+
11+
name: 编译QABook PDF
12+
13+
on:
14+
push:
15+
branches:
16+
- master
17+
paths:
18+
- 'qabook/**'
19+
- '.github/workflows/qabook-build.yml'
20+
workflow_dispatch:
21+
22+
permissions:
23+
contents: write
24+
25+
jobs:
26+
build-pdf:
27+
name: 编译LaTeX为PDF
28+
runs-on: ubuntu-latest
29+
30+
steps:
31+
- name: 检出代码
32+
uses: actions/checkout@v4
33+
with:
34+
fetch-depth: 0
35+
36+
- name: 安装TeX Live
37+
run: |
38+
echo "📦 安装TeX Live..."
39+
sudo apt-get update
40+
sudo apt-get install -y \
41+
texlive-xetex \
42+
texlive-latex-extra \
43+
texlive-lang-chinese \
44+
texlive-fonts-recommended \
45+
texlive-science \
46+
fonts-wqy-microhei \
47+
fonts-wqy-zenhei
48+
49+
- name: 验证XeLaTeX安装
50+
run: |
51+
echo "✅ 验证XeLaTeX..."
52+
xelatex --version
53+
54+
- name: 编译PDF (第一次)
55+
working-directory: qabook
56+
run: |
57+
echo "📄 第一次编译..."
58+
xelatex -interaction=nonstopmode quantaxis.tex || {
59+
echo "❌ 编译失败，查看日志："
60+
tail -50 quantaxis.log
61+
exit 1
62+
}
63+
64+
- name: 编译PDF (第二次)
65+
working-directory: qabook
66+
run: |
67+
echo "📄 第二次编译..."
68+
xelatex -interaction=nonstopmode quantaxis.tex
69+
70+
- name: 编译PDF (第三次)
71+
working-directory: qabook
72+
run: |
73+
echo "📄 第三次编译..."
74+
xelatex -interaction=nonstopmode quantaxis.tex
75+
76+
- name: 检查PDF生成
77+
working-directory: qabook
78+
run: |
79+
if [ -f "quantaxis.pdf" ]; then
80+
FILE_SIZE=$(du -h quantaxis.pdf | cut -f1)
81+
echo "✅ PDF生成成功！"
82+
echo "📊 文件大小: ${FILE_SIZE}"
83+
ls -lh quantaxis.pdf
84+
else
85+
echo "❌ PDF生成失败！"
86+
exit 1
87+
fi
88+
89+
- name: 生成版本标签
90+
id: version
91+
run: |
92+
# 使用日期作为版本号
93+
VERSION="qabook-$(date +'%Y%m%d-%H%M%S')"
94+
echo "version=${VERSION}" >> $GITHUB_OUTPUT
95+
echo "📌 版本: ${VERSION}"
96+
97+
- name: 创建Release
98+
id: create_release
99+
uses: actions/create-release@v1
100+
env:
101+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
102+
with:
103+
tag_name: ${{ steps.version.outputs.version }}
104+
release_name: QABook PDF - ${{ steps.version.outputs.version }}
105+
body: |
106+
# QUANTAXIS QABook PDF
107+
108+
**自动编译生成**
109+
110+
- 📅 编译时间: ${{ github.event.head_commit.timestamp }}
111+
- 🔖 提交: ${{ github.sha }}
112+
- 👤 作者: ${{ github.actor }}
113+
- 💬 提交信息: ${{ github.event.head_commit.message }}
114+
115+
---
116+
117+
## 📥 下载
118+
119+
点击下方的 `quantaxis.pdf` 下载完整文档。
120+
121+
## 📚 内容
122+
123+
QABook包含QUANTAXIS的完整技术文档，涵盖：
124+
- 量化交易理论基础
125+
- 数学和统计学知识
126+
- 现代资产管理理论
127+
- 组合优化策略
128+
- 期权定价理论
129+
130+
---
131+
132+
**自动生成 by GitHub Actions**
133+
draft: false
134+
prerelease: false
135+
136+
- name: 上传PDF到Release
137+
uses: actions/upload-release-asset@v1
138+
env:
139+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
140+
with:
141+
upload_url: ${{ steps.create_release.outputs.upload_url }}
142+
asset_path: ./qabook/quantaxis.pdf
143+
asset_name: quantaxis.pdf
144+
asset_content_type: application/pdf
145+
146+
- name: 清理临时文件
147+
if: always()
148+
working-directory: qabook
149+
run: |
150+
echo "🧹 清理临时文件..."
151+
rm -f *.aux *.log *.out *.toc *.gz *.fdb_latexmk *.fls *.synctex.gz || true
152+
153+
- name: 完成
154+
run: |
155+
echo "✅ QABook PDF编译完成！"
156+
echo "📦 已发布到Release: ${{ steps.version.outputs.version }}"

‎README.md‎

Lines changed: 25 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
11
# QUANTAXIS 2.1.0-alpha2
22

3+
<div align="center">
4+
5+
**⭐ 如果这个项目对您有帮助，请点击Star支持我们！**
6+
7+
**🔄 Fork本项目开始您的量化交易之旅！**
8+
9+
Made with ❤️ by [@yutiansut](https://github.com/yutiansut) and [contributors](https://github.com/QUANTAXIS/QUANTAXIS/graphs/contributors)
10+
11+
© 2016-2025 QUANTAXIS. Released under the MIT License.
12+
13+
</div>
14+
15+
316
> 🚀 **全新升级**: Python 3.9+、QARS2 Rust核心集成、100x性能提升
417
>
518
> **最新版本**: v2.1.0-alpha2 | **Python**: 3.9-3.12 | **更新日期**: 2025-10-25
@@ -59,7 +72,17 @@ account.buy("000001", 10.5, "2025-01-15", 1000)
5972

6073
![QUANTAXIS_LOGO_LAST_small.jpg](./qalogo.png)
6174

75+
---
76+
77+
## 📞 联系方式
78+
79+
- **项目主页**: https://github.com/yutiansut/QUANTAXIS
80+
- **作者**: yutiansut
81+
- **Email**: [email protected]
82+
- **微信公众号**: QAPRO
83+
- **微信**: quantitativeanalysis
6284

85+
---
6386

6487

6588

@@ -543,7 +566,7 @@ QUANTAXIS 是一个开放的项目, 在开源的3年中有大量的小伙伴加
543566

544567
写代码不易...请作者喝杯咖啡呗? ☕
545568

546-
![支付宝捐赠](http://picx.gulizhu.com/alipay.png)
569+
![支付宝捐赠](config/ali.jpg)
547570

548571
**注**: 支付时请备注您的名字/昵称，我们会维护一个赞助列表感谢您的支持！
549572

@@ -560,7 +583,7 @@ QUANTAXIS 是一个开放的项目, 在开源的3年中有大量的小伙伴加
560583
本项目采用 **MIT License** 开源许可证。
561584

562585
```
563-
Copyright (c) 2017-2025 yutiansut/QUANTAXIS
586+
Copyright (c) 2016-2025 yutiansut/QUANTAXIS
564587
565588
Permission is hereby granted, free of charge, to any person obtaining a copy
566589
of this software and associated documentation files (the "Software"), to deal
@@ -617,25 +640,5 @@ QUANTAXIS得以实现离不开以下优秀的开源项目:
617640
- 📱 移动端支持
618641
- ☁️ 云原生部署
619642

620-
---
621-
622-
## 📞 联系方式
623-
624-
- **项目主页**: https://github.com/QUANTAXIS/QUANTAXIS
625-
- **作者**: yutiansut
626-
- **Email**: [email protected]
627-
- **微信公众号**: QUANTAXIS
628-
629-
---
630-
631-
<div align="center">
632643

633-
**⭐ 如果这个项目对您有帮助，请点击Star支持我们！**
634-
635-
**🔄 Fork本项目开始您的量化交易之旅！**
636644

637-
Made with ❤️ by [@yutiansut](https://github.com/yutiansut) and [contributors](https://github.com/QUANTAXIS/QUANTAXIS/graphs/contributors)
638-
639-
© 2017-2025 QUANTAXIS. Released under the MIT License.
640-
641-
</div>

‎config/ali.jpg‎

165 KB
Loading

‎doc/README.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,11 @@
3939
- [2.0 → 2.1 迁移](migration/v2.0-to-v2.1.md)
4040
- [兼容性状态](migration/COMPATIBILITY_STATUS.md)
4141

42+
### 📖 QABook - PDF技术文档
43+
- [QABook简介](qabook/introduction.md) - 完整PDF技术手册
44+
- [LaTeX编译指南](qabook/build-guide.md) - 本地编译说明
45+
- [下载PDF](https://github.com/QUANTAXIS/QUANTAXIS/releases) - 预编译版本
46+
4247
---
4348

4449
## 💡 推荐学习路径

‎doc/SUMMARY.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,3 +74,11 @@
7474
- [常见问题](appendix/faq.md)
7575
- [术语表](appendix/glossary.md)
7676
- [版本历史](appendix/changelog.md)
77+
78+
---
79+
80+
# 📖 QABook - PDF技术文档
81+
82+
- [QABook简介](qabook/introduction.md)
83+
- [LaTeX编译指南](qabook/build-guide.md)
84+
- [下载PDF文档](https://github.com/QUANTAXIS/QUANTAXIS/releases)

0 commit comments

Comments
 (0)