From 4d0f00db8d6f743c34eb86ad8e8e30c03083e001 Mon Sep 17 00:00:00 2001 From: EricWang Date: Sun, 26 Feb 2017 12:47:26 +0800 Subject: [PATCH] update docs --- README.rst | 69 +++++++++++---------- docs/source/development/basic_concept.rst | 4 +- docs/source/development/make_contribute.rst | 4 +- docs/source/index.rst | 29 ++++----- 4 files changed, 54 insertions(+), 52 deletions(-) diff --git a/README.rst b/README.rst index 9383cf75e..9fcf2dc14 100644 --- a/README.rst +++ b/README.rst @@ -30,25 +30,11 @@ RQAlpha RQAlpha 从数据获取、算法交易、回测引擎，实盘模拟，实盘交易到数据分析，为程序化交易者提供了全套解决方案。RQAlpha 具有灵活的配置方式，强大的扩展性，用户可以非常容易地定制专属于自己的程序化交易系统。 -NOTICE: 目前开源项目我们仅开放了日级别的历史数据和日回测功能，如果您是机构需要做量化、算法交易亦或是量化研究，都可以联系我们的机构端产品销售来获得更多的以下机构端产品功能支持，联系方法是 - 【销售电话】：0755-33967716 【QQ】：4848371 -============================ - -机构端产品功能： - -*   可以本地部署，使用pycharm、anaconda等工具做本地策略研发、模拟以及实盘交易，效率大大加强，本地管理自己的策略提高保密性 -*   极速调取经过清洗处理的历史数据接口服务，包括了：400多项指标的财务数据，股票、期货、ETF、LOF、分级基金等等10年+的日和分钟、tick级别的历史数据以及每日更新，股票、期货的实时数据支持，指数以及构成，板块分类，股本、换手率、融资融券等，天猫等电商销量数据，公募基金数据，舆情、公告类 -* 股票、期货的实盘交易订单管理系统以及实盘下单支持，从回测到实盘交易的一条龙系统以及服务支持 -* 策略的管理以及实盘的收益、风险计算等 -* 交易数据的保存以及提取分析 -* 业绩分析和风险管理系统 -* 解决Bug以及一些简单的定制化开发 - - RQAlpha 所有的策略都可以直接在 `Ricequant`_ 上进行回测和实盘模拟，并且可以通过微信和邮件实时推送您的交易信号。 `Ricequant`_ 是一个开放的量化算法交易社区，为程序化交易者提供免费的回测和实盘模拟环境，并且会不间断举行实盘资金投入的量化比赛。 -Feature +特点 ============================ * 易于使用: RQAlpha让您集中于策略的开发，一行简单的命令就可以执行您的策略。 @@ -58,17 +44,7 @@ Feature * 灵活的配置: RQAlpha 提供了一系列的配置选项，用户可以通过简单的配置来构建适合自己的交易系统。 * 强大的扩展性: RQAlpha 定义了一系列的 Mod Hook 接口，开发者可以基于 Mod 的开发模式，扩展 RQAlpha，无论是做实时监控，还是归因分析，RQAlpha 都可以通过扩展来实现。 -Getting Help -============================ - -关于RQAlpha的任何问题可以通过以下途径来获取帮助 - -* 查看 `FAQ`_ 页面找寻常见问题及解答 -* 可以通过 `索引`_ 或者 `搜索`_ 来查找特定问题 -* 在 `Github Issue`_ 中提交issue -* RQAlpha 交流群「487188429」 - -Quick Guide +快速指引 ============================ * `RQAlpha 介绍`_ @@ -82,20 +58,45 @@ RQAlpha API * `参数配置`_ : 启动 RQAlpha 参数配置 * `API`_ : RQAlpha API 文档 -Development +机构版 ============================ -* `How To Contribute`_ : 如何加入 RQAlpha 的开发 -* `Basic Concept`_ : 基本概念 -* `RQAlpha Mod`_ : 基于Mod来开发和扩展RQAlpha +目前 RQAlpha 开源版仅开放了日级别的历史数据和日回测功能，如果您是机构用户，需要做算法交易亦或是量化研究，都可以联系我们的机构端产品销售获得机构端产品功能支持。「销售电话」：0755-33967716 「QQ」：4848371 -Extra +机构端产品功能： + +*   可以本地部署，使用pycharm、anaconda等工具做本地策略研发、模拟以及实盘交易，效率大大加强，本地管理自己的策略提高保密性 +*   极速调取经过清洗处理的历史数据接口服务，包括了：400多项指标的财务数据，股票、期货、ETF、LOF、分级基金等等10年+的日和分钟、tick级别的历史数据以及每日更新，股票、期货的实时数据支持，指数以及构成，板块分类，股本、换手率、融资融券等，天猫等电商销量数据，公募基金数据，舆情、公告类 +* 股票、期货的实盘交易订单管理系统以及实盘下单支持，从回测到实盘交易的一条龙系统以及服务支持 +* 策略的管理以及实盘的收益、风险计算等 +* 交易数据的保存以及提取分析 +* 业绩分析和风险管理系统 +* 技术支持及定制化开发 + +加入开发 +============================ + +* `如何贡献代码`_ +* `基本概念`_ +* `RQAlpha 基于 Mod 进行扩展`_ + +其他 ============================ * `FAQ`_ * `History`_ * `TODO`_ +获取帮助 +============================ + +关于RQAlpha的任何问题可以通过以下途径来获取帮助 + +* 查看 `FAQ`_ 页面找寻常见问题及解答 +* 可以通过 `索引`_ 或者 `搜索`_ 来查找特定问题 +* 在 `Github Issue`_ 中提交issue +* RQAlpha 交流群「487188429」 + .. _Github Issue: https://github.com/ricequant/rqalpha/issues .. _Ricequant: https://www.ricequant.com/algorithms @@ -113,9 +114,9 @@ Extra .. _参数配置: http://rqalpha.readthedocs.io/zh_CN/stable/api/config.html .. _API: http://rqalpha.readthedocs.io/zh_CN/stable/api/base_api.html -.. _How To Contribute: http://rqalpha.readthedocs.io/zh_CN/stable/development/make_contribute.html -.. _Basic Concept: http://rqalpha.readthedocs.io/zh_CN/stable/development/basic_concept.html -.. _RQAlpha Mod: http://rqalpha.readthedocs.io/zh_CN/stable/development/mod.html +.. _如何贡献代码: http://rqalpha.readthedocs.io/zh_CN/stable/development/make_contribute.html +.. _基本概念: http://rqalpha.readthedocs.io/zh_CN/stable/development/basic_concept.html +.. _RQAlpha 基于 Mod 进行扩展: http://rqalpha.readthedocs.io/zh_CN/stable/development/mod.html .. _History: http://rqalpha.readthedocs.io/zh_CN/stable/history.html .. _TODO: http://rqalpha.readthedocs.io/zh_CN/stable/todo.html diff --git a/docs/source/development/basic_concept.rst b/docs/source/development/basic_concept.rst index 3f436ccfc..026599a19 100644 --- a/docs/source/development/basic_concept.rst +++ b/docs/source/development/basic_concept.rst @@ -1,10 +1,10 @@ .. _development-basic-concept: ================== -Basic Concept +基本概念 ================== -Interface +接口 ================== .. module:: rqalpha.interface diff --git a/docs/source/development/make_contribute.rst b/docs/source/development/make_contribute.rst index d9151e010..da7946f83 100644 --- a/docs/source/development/make_contribute.rst +++ b/docs/source/development/make_contribute.rst @@ -1,7 +1,7 @@ .. _development-make-contribute: ================== -How To Contribute +如何贡献代码 ================== .. _Ricequant: https://www.ricequant.com/algorithms @@ -16,7 +16,7 @@ RQAlpha 所有的开发工作都将会在 `RQAlpha Github`_ 上进行，无论 .. _development-make-contribute-branch-management: -Branch Management +分支管理 -------------------------- `master 分支`_ 为最新稳定版本，只有团队成员在发布新版本时才会将充分测试的 `develop 分支`_ 合并到 `master 分支`_ 中。 diff --git a/docs/source/index.rst b/docs/source/index.rst index 418bd93fc..b57256c4d 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -34,21 +34,11 @@ RQAlpha 所有的策略都可以直接在 `Ricequant`_ 上进行回测和实盘 `Ricequant`_ 是一个开放的量化算法交易社区，为程序化交易者提供免费的回测和实盘模拟环境，并且会不间断举行实盘资金投入的量化比赛。 -Getting Help -================== - -关于RQAlpha的任何问题可以通过以下途径来获取帮助 - -* 查看 :doc:`FAQ ` 页面找寻常见问题及解答 -* 可以通过 :ref:`genindex` 或者 :ref:`search` 来查找特定问题 -* 在 `github issue page`_ 中提交issue -* RQAlpha 交流群「487188429」 - -Quick Guide +快速指引 ================== .. toctree:: - :caption: Quick Guide + :caption: 快速指引 :hidden: intro/overview @@ -94,7 +84,7 @@ RQAlpha API 扩展API(开源版暂不支持，可以通过Ricequant平台或者商业版使用) -Development +扩展 RQAlpha ================== .. toctree:: @@ -114,7 +104,7 @@ Development :doc:`development/mod` 基于Mod来开发和扩展RQAlpha -Extra +其他 ================== .. toctree:: @@ -134,6 +124,17 @@ Extra :doc:`todo` TODO + +获取帮助 +================== + +关于RQAlpha的任何问题可以通过以下途径来获取帮助 + +* 查看 :doc:`FAQ ` 页面找寻常见问题及解答 +* 可以通过 :ref:`genindex` 或者 :ref:`search` 来查找特定问题 +* 在 `github issue page`_ 中提交issue +* RQAlpha 交流群「487188429」 + .. _github issue page: https://github.com/ricequant/rqalpha/issues .. _Ricequant: https://www.ricequant.com/algorithms