From e23c18186ba95da5f7bfce299c32159df194472e Mon Sep 17 00:00:00 2001 From: Blair Azzopardi Date: Sat, 30 Mar 2024 19:47:10 +0000 Subject: [PATCH] improve docs by incl non-exported names --- docs/yabte.backtest.rst | 30 +++++++++++++++++++++--------- 1 file changed, 21 insertions(+), 9 deletions(-) diff --git a/docs/yabte.backtest.rst b/docs/yabte.backtest.rst index 9207264..0f09672 100644 --- a/docs/yabte.backtest.rst +++ b/docs/yabte.backtest.rst @@ -6,27 +6,29 @@ Strategy -------- .. automodule:: yabte.backtest.strategy + :show-inheritance: + :ignore-module-all: :members: :member-order: bysource + :inherited-members: + StrategyRunner -------------- .. automodule:: yabte.backtest.strategyrunner + :show-inheritance: + :ignore-module-all: :members: :member-order: bysource + :inherited-members: + Order ----- - .. autoclass:: yabte.backtest.order.OrderStatus - :members: - :member-order: bysource - - .. autoclass:: yabte.backtest.order.OrderSizeType - :members: - :member-order: bysource - .. automodule:: yabte.backtest.order + :show-inheritance: + :ignore-module-all: :members: :member-order: bysource :inherited-members: @@ -35,20 +37,30 @@ Transaction ----------- .. automodule:: yabte.backtest.transaction + :show-inheritance: + :ignore-module-all: :members: :member-order: bysource :inherited-members: + Book ---- .. automodule:: yabte.backtest.book + :show-inheritance: + :ignore-module-all: :members: :member-order: bysource + :inherited-members: + Asset ----- .. automodule:: yabte.backtest.asset + :show-inheritance: + :ignore-module-all: :members: - :member-order: bysource \ No newline at end of file + :member-order: bysource + :inherited-members: