diff --git a/README.rst b/README.rst index 0284115..aaedb0d 100644 --- a/README.rst +++ b/README.rst @@ -2,7 +2,7 @@ HftBacktest =========== -|codacy| |codeql| |pypi| |downloads| |license| +|codacy| |codeql| |pypi| |downloads| |license| |docs| High-Frequency Trading Backtesting Tool in Python ==================================================================== @@ -40,7 +40,7 @@ Or you can clone the latest development version from the Git repository with: Data Source & Format -------------------- -Please see `Data `_ or `Data Preparation `_. +Please see `Data `_ or `Data Preparation `_. A Quick Example --------------- @@ -155,3 +155,8 @@ See `here `_. .. |license| image:: https://img.shields.io/badge/License-MIT-green.svg :alt: |License :target: https://github.com/nkaz001/hftbacktest/blob/master/LICENSE + +.. |docs| image:: https://readthedocs.org/projects/hftbacktest/badge/?version=latest + :target: https://hftbacktest.readthedocs.io/en/latest/?badge=latest + :alt: Documentation Status + diff --git a/setup.cfg b/setup.cfg index 7f30041..452cf58 100644 --- a/setup.cfg +++ b/setup.cfg @@ -3,7 +3,7 @@ name = hftbacktest version = attr: hftbacktest.__version__ url = https://github.com/nkaz001/hftbacktest project_urls = - Docs = https://github.com/nkaz001/hftbacktest/wiki + Docs = https://hftbacktest.readthedocs.io/en/latest/ GitHub: issues = https://github.com/nkaz001/hftbacktest/issues GitHub: repo = https://github.com/nkaz001/hftbacktest description = High-frequency trading and market making backtesting tool