mirror of
https://github.com/wassname/catalyst.git
synced 2026-08-18 11:50:11 +08:00
DOC: updating documentation
This commit is contained in:
+25
-18
@@ -165,46 +165,51 @@
|
||||
<li class="toctree-l3"><a class="reference internal" href="releases.html#bug-fixes">Bug Fixes</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#version-0-3-9">Version 0.3.9</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="releases.html#id1">Bug Fixes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#id1">Version 0.3.10</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="releases.html#id2">Bug Fixes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="releases.html#build">Build</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#version-0-3-8">Version 0.3.8</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="releases.html#id2">Bug Fixes</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#version-0-3-7">Version 0.3.7</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#version-0-3-9">Version 0.3.9</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="releases.html#id3">Bug Fixes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="releases.html#id4">Build</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#version-0-3-6">Version 0.3.6</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#version-0-3-8">Version 0.3.8</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="releases.html#id5">Bug Fixes</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#version-0-3-5">Version 0.3.5</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#version-0-3-7">Version 0.3.7</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="releases.html#id6">Bug Fixes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="releases.html#id7">Build</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#version-0-3-6">Version 0.3.6</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="releases.html#id8">Bug Fixes</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#version-0-3-5">Version 0.3.5</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="releases.html#id9">Bug Fixes</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#version-0-3-4">Version 0.3.4</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="releases.html#id7">Bug Fixes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="releases.html#id8">Build</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="releases.html#id10">Bug Fixes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="releases.html#id11">Build</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="releases.html#documentation">Documentation</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#version-0-3-3">Version 0.3.3</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="releases.html#id10">Bug Fixes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="releases.html#id11">Build</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="releases.html#id13">Bug Fixes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="releases.html#id14">Build</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#version-0-3-2">Version 0.3.2</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="releases.html#id12">Bug Fixes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="releases.html#id13">Build</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="releases.html#id15">Bug Fixes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="releases.html#id16">Build</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#version-0-3-1">Version 0.3.1</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="releases.html#id14">Bug Fixes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="releases.html#id17">Bug Fixes</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="releases.html#version-0-3">Version 0.3</a></li>
|
||||
@@ -265,6 +270,7 @@ and what is planned for future releases.</p>
|
||||
<ul class="simple">
|
||||
<li>Backtesting and live-trading modes to run your trading algorithms, with a
|
||||
seamless transition between the two.</li>
|
||||
<li>Paper trading simulates order in live-trading mode.</li>
|
||||
<li>Support for 3 exchanges: Bitfinex, Bittrex and Poloniex in both modes
|
||||
(backtesting and live-trading). Historical data for backtesting is provided
|
||||
with daily resolution for all three exchanges, and minute resolution for
|
||||
@@ -272,6 +278,9 @@ Bitfinex and Poloniex. No minute-resolution data is currently available for
|
||||
Bittrex. Refer to
|
||||
<a class="reference external" href="https://www.enigma.co/catalyst/status">Catalyst Market Coverage</a> for
|
||||
details.</li>
|
||||
<li>Interface with over 90 exchanges available in live and paper trading modes.</li>
|
||||
<li>Granular commission models which closely simulates each exchange fee
|
||||
structure in backtesting and paper trading.</li>
|
||||
<li>Standardized naming convention for all asset pairs trading on any exchange in
|
||||
the form <code class="docutils literal"><span class="pre">{market_currency}_{base_currency}</span></code>. See
|
||||
<a class="reference internal" href="#naming"><span>Naming Convention</span></a>.</li>
|
||||
@@ -296,8 +305,6 @@ can be specified through <code class="docutils literal"><span class="pre">set_be
|
||||
<div class="section" id="upcoming-features">
|
||||
<h2>Upcoming features<a class="headerlink" href="#upcoming-features" title="Permalink to this headline">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li>Paper trading mode (v0.4 - mid Dec. 2017)</li>
|
||||
<li>Support for additional exchanges (v0.4 - mid Dec. 2017)</li>
|
||||
<li>Additional datasets beyond pricing data (Dec. 2017)</li>
|
||||
<li>API documentation (Jan. 2017)</li>
|
||||
<li>Support for decentralized exchanges (Jan. 2017)</li>
|
||||
|
||||
Reference in New Issue
Block a user