Update docs

bsdz · Mar 29, 2024 · ddc7042 · ddc7042
1 parent 4bb1193
commit ddc7042
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 6 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -100,19 +100,19 @@ To run our strategy, we use a StrategyRunner:
       # index containing timestamps.
       data=pd.concat([df_goog, df_msft], axis=1),
       assets=assets,
-      strat_classes=[SMAXO],
+      strategies=[SMAXO()],
       books=[book],
    )
-   sr.run()
+   srr = sr.run()
 
 
 Once a runner has completed we can access book value history and transaction history
 via our instance:
 
 .. code-block:: python
 
-   th = sr.transaction_history
-   bch = sr.book_history
+   th = srr.transaction_history
+   bch = srr.book_history
 
 
 .. toctree::

diff --git a/docs/yabte.backtest.rst b/docs/yabte.backtest.rst
@@ -9,7 +9,14 @@ Strategy
       :members:
       :member-order: bysource
 
-SimpleOrder
+StrategyRunner
+--------------
+
+   .. automodule:: yabte.backtest.strategyrunner
+      :members:
+      :member-order: bysource
+
+Order
 -----
    .. autoclass:: yabte.backtest.order.OrderStatus
       :members:
@@ -39,7 +46,7 @@ Book
       :members:
       :member-order: bysource
 
-OHLCAsset
+Asset
 -----
 
    .. automodule:: yabte.backtest.asset