===========================================
 QFF  |version| documentation!
===========================================
.. only:: html

    .. image:: https://img.shields.io/pypi/v/qff
       :target: https://pypi.python.org/pypi/qff
       :alt: PyPI Version
    ..  image:: https://img.shields.io/pypi/dm/qff?label=pypi%20downloads
        :target: https://pypi.python.org/pypi/qff
        :alt: PyPI - Downloads
    .. image:: https://img.shields.io/docker/v/haijiangxu/qff
       :target: https://hub.docker.com/r/haijiangxu/qff
       :alt: Docker Image Version (latest by date)
    .. image:: https://readthedocs.org/projects/qff/badge/?version=latest
        :target: https://qff.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status

    QFF是基于Python语言开发的一个量化金融框架库，提供数据获取-数据存储-策略编写-策略分析-策略回测-模拟交易等一站式解决方案。

    .. note::

       请访问 `Github`_ 网站获取QFF源代码，如果有任何问题请访问 `Github Issues`_ 查询或提交，或加入QQ群 775477625 参与讨论。

    .. _Github: https://github.com/haijiangxu/qff

    .. _Github Issues: https://github.com/haijiangxu/qff/issues


.. toctree::
    :maxdepth: 2
    :glob:
    :caption: 开始

    intro/background
    intro/introduction
    intro/installation
    intro/qffdocker
    intro/getstarted

.. toctree::
    :maxdepth: 2
    :glob:
    :caption: 用户指南

    guide/writing
    guide/running
    guide/evaluation
    guide/trader
    guide/example
    guide/datadict

.. toctree::
    :maxdepth: 2
    :glob:
    :caption: API

    api/frame_api
    api/data_api

.. toctree::
    :maxdepth: 2
    :glob:
    :caption: 开发

    tasklist
    CHANGELOG