update docs

docs/source/faq.rst

@@ -4,6 +4,24 @@
 FAQ
 ==================
 
-1. 运行回测时，matplotlib 报错怎么办？RuntimeError: Python is not installed as a framework.
+1.  运行回测时，matplotlib 报错怎么办？RuntimeError: Python is not installed as a framework.
 
-    解决方案：创建文件 ~/.matplotlib/matplotlibrc，并加入代码`backend: TkAgg`
+    解决方案：创建文件 ~/.matplotlib/matplotlibrc，并加入代码`backend: TkAgg`
+
+2.  在Windows运行报`Error on import matplotlib.pyplot`
+
+    请访问 `Error on import matplotlib.pyplot (on Anaconda3 for Windows 10 Home 64-bit PC) <http://stackoverflow.com/questions/34004063/error-on-import-matplotlib-pyplot-on-anaconda3-for-windows-10-home-64-bit-pc>`_ 解决。
+
+3.  在Windows出现缺失`cl.exe`
+
+    请访问 https://wiki.python.org/moin/WindowsCompilers 下载VC并且安装。
+
+4.  Windows 安装时报 `error: Microsoft Visual C++ 14.0 is required.` 
+
+    请访问 https://wiki.python.org/moin/WindowsCompilers 下载VC并且安装。
+
+5.  出现安装 `bcolz` 编译失败
+
+    在 Windows 环境下编译 `bcolz` 需要 Cython 和 VC，请参考 FAQ 3 & 4
+
+    或者不进行编译安装，访问 http://www.lfd.uci.edu/~gohlke/pythonlibs/#bcolz 下载 `bcolz` 直接进行安装。

docs/source/index.rst

@@ -25,20 +25,24 @@ Quick Guide
 ==================
 
 .. toctree::
-   :caption: Quick Guide
-   :hidden:
+    :caption: Quick Guide
+    :hidden:
 
-   intro/overview
-   intro/install
-   intro/tutorial
-   intro/examples
+    intro/overview
+    intro/install
+    intro/detail_install
+    intro/tutorial
+    intro/examples
 
 :doc:`intro/overview`
     了解RQAlpha
 
 :doc:`intro/install`
     安装RQAlpha
 
+:doc:`intro/detail_install`
+    如果对Python并不熟悉的话，我们提供了整套开发环境的详细安装教程
+
 :doc:`intro/tutorial`
     使用RQAlpha
 
@@ -50,12 +54,12 @@ RQAlpha API
 ==================
 
 .. toctree::
-   :caption: API
-   :hidden:
+    :caption: API
+    :hidden:
 
-   api/config
-   api/base_api
-   api/extend_api
+    api/config
+    api/base_api
+    api/extend_api
 
 :doc:`api/config`
     启动 RQAlpha 参数配置
@@ -71,12 +75,12 @@ Development
 ==================
 
 .. toctree::
-   :caption: Development
-   :hidden:
+    :caption: Development
+    :hidden:
 
-   development/make_contribute
-   development/basic_concept
-   development/mod
+    development/make_contribute
+    development/basic_concept
+    development/mod
 
 :doc:`development/make_contribute`
     如何加入 RQAlpha 的开发
@@ -91,11 +95,11 @@ Extra
 ==================
 
 .. toctree::
-   :caption: Extra
-   :hidden:
+    :caption: Extra
+    :hidden:
 
-   faq
-   history
+    faq
+    history
 
 :doc:`faq`
     FAQ

docs/source/intro/detail_install.rst

@@ -0,0 +1,159 @@
+.. _intro-detail-install:
+
+==================
+详细环境搭建
+==================
+
+注意：因为 RQAlpha使用了一些 Python 3 的特性，所以目前只支持 **>= python 3.4** 的版本，之后会增加 python 2 的兼容，不过还是建议您使用 Python 3 来进行开发和使用。
+
+Anaconda
+====================================
+
+安装
+------------------------------------
+
+**如果您已经安装好了 Anaconda(Python 3) 环境，可以跳过这个环节**
+
+Anaconda 是一个用于科学计算的 Python 发行版，支持 Linux, Mac, Windows, 包含了众多流行的科学计算、数据分析的 Python 包。
+
+Anaconda 环境包含了常用的 Python 科学计算库及依赖关系，而 RQAlpha 有很多模块是依赖于这些科学计算库的，因此下载 Anaconda 可以轻松搭建出一个强大的 Python 量化研发的基础环境。
+
+安装 Anaconda 需要新下载最新的安装包。我们建议您下载最新的 Python 3.5 Anaconda 安装包，具体地址如下:
+
+1.  官方下载：https://www.continuum.io/downloads  （我们不是特别建议，因为官方下载的速度较慢，但是如果您非常认可官方的可信度可以考虑...）
+2.  清华的官方镜像下载：https://mirrors.tuna.tsinghua.edu.cn/anaconda/archive/  ，找最新的anaconda版本下载即可
+
+For CentOS
+------------------------------------
+
+首先从清华的官方镜像下载 anaconda Linux64版本
+
+.. code-block:: bash
+
+    wget https://mirrors.tuna.tsinghua.edu.cn/anaconda/archive/Anaconda3-4.2.0-Linux-x86_64.sh
+
+修改权限让脚本可以运行
+
+.. code-block:: bash
+
+    chmod +x Anaconda3-4.2.0-Linux-x86_64.sh
+
+运行该安装脚本
+
+.. code-block:: bash
+
+    ./Anaconda3-4.2.0-Linux-x86_64.sh
+
+剩下就是一路Yes或者Enter好了...
+
+.. code-block:: bash
+
+    Welcome to Anaconda3 4.2.0 (by Continuum Analytics, Inc.)
+     
+     
+    In order to continue the installation process, please review the license
+     
+    agreement.
+     
+    Please, press ENTER to continue
+    >>>
+
+重新加载一下 bash 就可以使用 `conda` 命令了
+
+.. code-block:: bash
+
+    source ~/.bashrc
+
+然后尝试一下运行 `conda -V` 命令行看是否已经安装成功，如果返回对应的版本信息，则说明安装成功。
+
+.. code-block:: bash
+
+    conda -V
+
+设置matplotlib的backend（没有图形化界面的情况下）
+
+.. code-block:: bash
+
+echo "backend: Agg" > ~/.config/matplotlib/matplotlibrc
+
+安装中文字体: 将 WenQuanYi Micro Hei.ttf 放到 /usr/share/fonts/chinese 
+
+.. code-block:: bash
+
+    mkdir /usr/share/fonts/chinese
+    cd /usr/share/fonts/chinese
+    wget https://static.ricequant.com/assets/data/WenQuanYi%20Micro%20Hei.ttf
+    fc-cache -fv
+    fc-list
+    rm -rf ~/.cache/matplotlib
+    rm -rf ~/.fontconfig
+
+
+更改 Anaconda 源，提高下载速度
+------------------------------------
+
+conda 官方的服务器在国外，因此国内的网络环境使用 `conda` 可能会比较慢，建议您根据自己的网络环境选择是否更换 `conda` 源。
+
+清华大学提供了Anaconda的仓库镜像，我们只需要配置Anaconda的配置文件，添加清华的镜像源，然后将其设置为第一搜索渠道即可：
+运行以下命令行:
+
+..  code-block:: bash
+
+    conda config --add channels 'https://mirrors.tuna.tsinghua.edu.cn/anaconda/pkgs/free/'
+    conda config --set show_channel_urls yes
+
+设置好源后，就可以使用 `conda install 【包名】` 安装需要的 Python 库了。大部分情况下，建议使用 `conda` 来安装 Python 数据分析相关的库，因为 conda 做了很多的优化和版本依赖关系的管理。如果没有相关的库，则使用 `pip install 【包名】` 的方式来安装。
+
+conda 虚拟环境
+------------------------------------
+
+*   构建 conda 虚拟环境
+
+我们强烈建议您去创建并使用Python虚拟环境，因为这样才能让您的开发环境更加独立，不会因为安装不同的包而出现问题，造成运行失败等。
+
+目前流行的Python虚拟环境有两种：conda 和 pyenv, 由于大部分的量化开发都是基于 Anaconda 的 python 技术栈，因此我们建议您使用 conda 作为默认的虚拟环境开发。
+
+一下有几个常用的虚拟环境命令可以使用:
+
+*   创建 conda 虚拟环境
+
+.. code-block:: bash
+
+    conda create --name env_name python=3.5 
+
+*   使用 conda 虚拟环境
+
+.. code-block:: bash
+
+    source activate env_name
+
+*   退出 conda 虚拟环境
+
+.. code-block:: bash
+
+    source deactivate env_name
+
+*   删除 conda 虚拟环境
+
+    conda-env remove --name env_name
+
+注意: **Windows下无需加上 source**
+
+安装 RQAlpha
+====================================
+
+RQAlpha 的相关安装 请参考 :ref:`intro-install`
+
+.. _intro-detail-install-talib:
+
+安装 TA-Lib
+====================================
+
+您可以使用PyPI安装::
+
+    $ pip install TA-Lib
+
+如果发现无法通过 pip 安装，请访问 https://mrjbq7.github.io/ta-lib/install.html 解决。
+
+对于 Windows 用户，如果编译困难，可以根据您本地的Python版本下载指定的whl包，然后 `pip install TA_Lib-0.4.9-cp27-none-win_amd64.whl` 来完成安装。
+

docs/source/intro/install.rst

@@ -9,6 +9,15 @@
 
 RQAlpha目前只支持 python 3.4 及以上，Python 2 暂不支持。
 
+安装前
+==================
+
+我们强烈建议您在安装 RQAlpha 前，首先单独安装 bcolz 库，因为其编译时间较长，并且中间比较容易失败，单独安装好以后再继续安装RQAlpha。
+
+Windows 环境下编译安装 bcolz 需要使用Visual C++ Compiler，需要自行下载并安装 visual-cpp-build-tools，
+
+如果觉得麻烦，也可以直接去 http://www.lfd.uci.edu/~gohlke/pythonlibs/#bcolz 下载相应版本的boclz wheel包，直接安装编译后的 bcolz 版本。
+
 安装
 ==================
 
@@ -37,34 +46,16 @@ RiceQuant 免费提供日级别的股票和期货数据供回测使用，可以
 
     $ rqalpha update_bundle
 
-平台相关的安装问题
-==================
-
-在Windows运行报`Error on import matplotlib.pyplot`
-------------------------------------------------------
-
-请访问 `Error on import matplotlib.pyplot (on Anaconda3 for Windows 10 Home 64-bit PC) <http://stackoverflow.com/questions/34004063/error-on-import-matplotlib-pyplot-on-anaconda3-for-windows-10-home-64-bit-pc>`_ 解决。
-
-在Windows出现缺失`cl.exe`
-----------------------------
-
-请访问 https://wiki.python.org/moin/WindowsCompilers 下载VC并且安装。
-
-出现安装 `bcolz` 编译失败
----------------------------
-
-访问 http://www.lfd.uci.edu/~gohlke/pythonlibs/#bcolz 下载 `bcolz` 安装，之后再安装rqalpha。
-
-.. _intro-install-talib:
+bundle 文件默认存放在 `~/.rqalpha` 下，您也可以指定 bundle 文件的存放位置，
 
-安装 `TA-Lib`
-------------------
+.. code-block:: bash
 
-您可以使用PyPI安装::
+    $ rqalpha update_bundle -d target_bundle_path
 
-    $ pip install TA-Lib
+如果您使用了指定路径来存放 bundle，那么执行程序的时候也同样需要指定对应的 bundle 路径。
 
-如果发现无法通过 pip 安装，请访问 https://mrjbq7.github.io/ta-lib/install.html 解决。
+.. code-block:: bash
 
-对于 Windows 用户，如果编译困难，可以根据您本地的Python版本下载指定的whl包，然后 `pip install TA_Lib-0.4.9-cp27-none-win_amd64.whl` 来完成安装。
+    $ rqalpha run -d target_bundle_path .....
 
+详细参数配置请查看 :ref:`api-config`

docs/source/intro/tutorial.rst

@@ -115,7 +115,7 @@ Ricequant 金融、财务、合约历史数据等数据接口，详情请查看
 
 *   bar_dict: 在 :func:`handle_bar` 中我们可以使用 `bar_dict` 来获取相应的 :class:`Bar` 数据，`bar_dict` 是一个字典类型变量，直接通过传 `key` 的方式就可以获取到对应的 :class:`Bar` 数据。
 
-*   我们可以引用第三方库来帮我们生成相应的指标序列，比如使用 `TA-Lib`_ 来获取移动平均线序列。`TA-Lib`_ 的安装可以参考 :ref:`intro-install-talib` 相应文档。
+*   我们可以引用第三方库来帮我们生成相应的指标序列，比如使用 `TA-Lib`_ 来获取移动平均线序列。`TA-Lib`_ 的安装可以参考 :ref:`intro-detail-install-talib` 相应文档。
 
 .. _TA-Lib: https://github.com/mrjbq7/ta-lib