Skip to content

Commit

Permalink
Merge pull request #498 from mar-heaven/master
Browse files Browse the repository at this point in the history
update doc
  • Loading branch information
Cuizi7 committed Apr 29, 2020
2 parents 2dad195 + 6c2890d commit e498047
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions docs/source/development/mod.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ Mod开发环境搭建
├── README.rst
├── setup.py
└── rqalpha_mod_hello
   ├── __init__.py
   └── mod.py
├── __init__.py
└── mod.py
假设在新的环境中已经可以成功运行 RQAlpha ,便按照Mod的标准命名格式创建项目 :code:`rqalpha-mod-hello`。进入 :code:`rqalpha-mod-hello` 文件夹,创建 :code:`__init__.py`,填入以下代码:

Expand Down Expand Up @@ -85,7 +85,7 @@ PyPI方式安装Mod
from pip._internal.req import parse_requirements
except ImportError: # for pip <= 9.0.3
from pip.req import parse_requirements
from setuptools import (
find_packages,
setup,
Expand Down Expand Up @@ -128,19 +128,19 @@ PyPI方式安装Mod
会扫描当前目录下的 :code:`setup.py` 文件执行安装,同时直接修改项目内文件就可以实现修改对应Mod。

安装成功后将看到下图:

.. image:: https://raw.githubusercontent.com/ricequant/rq-resource/master/rqalpha/mod-install-success.png


激活以及使用Mod
--------------------

对 Mod 进行激活
激活并查看我们安装的mod

.. code-block:: bash
$ rqalpha mod enable hello
$ rqalpha mod list
.. image:: https://raw.githubusercontent.com/ricequant/rq-resource/master/rqalpha/mod-install-success.png


运行RQAlpha即可看到如下:

Expand Down Expand Up @@ -238,7 +238,7 @@ RQAlpha 支持安装、卸载、启用、停止第三方Mod。

1. 需要定义并实现 :code:`load_mod` 函数, 其返回值为对应的继承自 :code:`AbstractMod` 的类,并且 :code:`load_mod` 所在文件必须按照 :code:`rqalpha_mod_xxx` 规则进行命名。
2. 如果有自定义参数的话,需要实现 :code:`__mod_config__` 变量,其为字符串,配置的具体格式为 `yaml` 格式(支持注释)。RQAlpha 会自动将其扩展到默认配置项中。
3. 当写好 Mod 以后,需要发布到 Pypi 仓库中,并且包名需要如下格式: :code:`rqalpha-mod-xxx`,一下的 setup.py 文件可作参考。
3. 当写好 Mod 以后,需要发布到 Pypi 仓库中,并且包名需要如下格式: :code:`rqalpha-mod-xxx`,以下的 setup.py 文件可作参考。

.. code-block:: python3
Expand Down Expand Up @@ -274,4 +274,4 @@ RQAlpha 支持安装、卸载、启用、停止第三方Mod。
如您不熟悉PyPI发布的流程,请参考官方文档:https://packaging.python.org/distributing/


如果您希望更多人使用您的Mod,您也可以联系我们,我们审核通过后,会在 RQAlpha 项目介绍和文档中增加您的Mod的介绍和推荐。
如果您希望更多人使用您的Mod,您也可以联系我们,我们审核通过后,会在 RQAlpha 项目介绍和文档中增加您的Mod的介绍和推荐。

0 comments on commit e498047

Please sign in to comment.