From b10bfc98a13ee904049ab0d6774636cbcdb1dba6 Mon Sep 17 00:00:00 2001 From: Tobias Brandt Date: Wed, 14 Nov 2012 14:29:50 +0200 Subject: [PATCH] DOC: Added autodoc generating links for all submodules --- docs/overview.rst | 4 +-- docs/zipline.data.rst | 40 ++++++++++++++++++++++++++ docs/zipline.finance.rst | 25 +++++++++++++++-- docs/zipline.gens.rst | 40 ++++++++++++++++++++++++++ docs/zipline.rst | 20 +++++++------ docs/zipline.transforms.rst | 47 +++++++++++++++++++++++++++++++ docs/zipline.utils.rst | 56 +++++++++++++++++++++++++++++++++++++ 7 files changed, 220 insertions(+), 12 deletions(-) create mode 100644 docs/zipline.data.rst create mode 100644 docs/zipline.gens.rst create mode 100644 docs/zipline.transforms.rst create mode 100644 docs/zipline.utils.rst diff --git a/docs/overview.rst b/docs/overview.rst index c6bd676f..9d7d3ad5 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -8,9 +8,9 @@ Simulations :mod:`zipline` runs backtests using asynchronous components and zeromq messaging for communication and coordination. -Simulator is the heart of :mod:zipline, and the primary access point for creating, +:class:`.algorithm.TradingAlgorithm` is the heart of :mod:`zipline`, and the primary access point for creating, launching, and tracking simulations. You can find it in -:py:class:`~zipline.core.Simulator` +:py:class:`~zipline.algorithm.TradingAlgorithm` Simulator Sub-Components ======================== diff --git a/docs/zipline.data.rst b/docs/zipline.data.rst new file mode 100644 index 00000000..c7269916 --- /dev/null +++ b/docs/zipline.data.rst @@ -0,0 +1,40 @@ +:mod:`zipline.data` subpackage +=============================== + +.. automodule:: zipline.data.__init__ + :members: + :undoc-members: + :show-inheritance: + +:mod:`benchmarks` Module +------------------------- + +.. automodule:: zipline.data.benchmarks + :members: + :undoc-members: + :show-inheritance: + +:mod:`loader` Module +-------------------- + +.. automodule:: zipline.data.loader + :members: + :undoc-members: + :show-inheritance: + +:mod:`loader_utils` Module +-------------------------- + +.. automodule:: zipline.data.loader_utils + :members: + :undoc-members: + :show-inheritance: + +:mod:`treasuries` Module +------------------------ + +.. automodule:: zipline.data.treasuries + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/zipline.finance.rst b/docs/zipline.finance.rst index e99189f6..33b8fe59 100644 --- a/docs/zipline.finance.rst +++ b/docs/zipline.finance.rst @@ -1,5 +1,18 @@ -finance Package -=============== +:mod:`zipline.finance` subpackage +================================== + +.. automodule:: zipline.finance.__init__ + :members: + :undoc-members: + :show-inheritance: + +:mod:`commission` Module +------------------------- + +.. automodule:: zipline.finance.commission + :members: + :undoc-members: + :show-inheritance: :mod:`performance` Module ------------------------- @@ -17,6 +30,14 @@ finance Package :undoc-members: :show-inheritance: +:mod:`slippage` Module +------------------------- + +.. automodule:: zipline.finance.slippage + :members: + :undoc-members: + :show-inheritance: + :mod:`trading` Module --------------------- diff --git a/docs/zipline.gens.rst b/docs/zipline.gens.rst new file mode 100644 index 00000000..b6d344aa --- /dev/null +++ b/docs/zipline.gens.rst @@ -0,0 +1,40 @@ +:mod:`zipline.gens` subpackage +============================== + +.. automodule:: zipline.gens.__init__ + :members: + :undoc-members: + :show-inheritance: + +:mod:`composites` Module +------------------------- + +.. automodule:: zipline.gens.composites + :members: + :undoc-members: + :show-inheritance: + +:mod:`sort` Module +------------------ + +.. automodule:: zipline.gens.sort + :members: + :undoc-members: + :show-inheritance: + +:mod:`tradesimulation` Module +------------------------------ + +.. automodule:: zipline.gens.tradesimulation + :members: + :undoc-members: + :show-inheritance: + +:mod:`utils` Module +--------------------- + +.. automodule:: zipline.gens.utils + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/zipline.rst b/docs/zipline.rst index cf294c88..87be42b1 100644 --- a/docs/zipline.rst +++ b/docs/zipline.rst @@ -1,18 +1,23 @@ -zipline Package -=============== - :mod:`zipline` Package ----------------------- +======================= .. automodule:: zipline.__init__ :members: :undoc-members: :show-inheritance: -:mod:`protocol` Module +:mod:`algorithm` Module +------------------------- + +.. automodule:: zipline.algorithm + :members: + :undoc-members: + :show-inheritance: + +:mod:`sources` Module ---------------------- -.. automodule:: zipline.protocol +.. automodule:: zipline.sources :members: :undoc-members: :show-inheritance: @@ -38,10 +43,9 @@ Subpackages .. toctree:: - zipline.core zipline.data zipline.finance zipline.gens - zipline.optimize + zipline.transforms zipline.utils diff --git a/docs/zipline.transforms.rst b/docs/zipline.transforms.rst new file mode 100644 index 00000000..84e9648d --- /dev/null +++ b/docs/zipline.transforms.rst @@ -0,0 +1,47 @@ +:mod:`zipline.transforms` subpackage +===================================== + +.. automodule:: zipline.transforms.__init__ + :members: + :undoc-members: + :show-inheritance: + +:mod:`mavg` Module +------------------------- + +.. automodule:: zipline.transforms.mavg + :members: + :undoc-members: + :show-inheritance: + +:mod:`returns` Module +------------------------- + +.. automodule:: zipline.transforms.returns + :members: + :undoc-members: + :show-inheritance: + +:mod:`stddev` Module +------------------------- + +.. automodule:: zipline.transforms.stddev + :members: + :undoc-members: + :show-inheritance: + +:mod:`utils` Module +------------------------- + +.. automodule:: zipline.transforms.utils + :members: + :undoc-members: + :show-inheritance: + +:mod:`vwap` Module +------------------------- + +.. automodule:: zipline.transforms.vwap + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/zipline.utils.rst b/docs/zipline.utils.rst new file mode 100644 index 00000000..e7851fe0 --- /dev/null +++ b/docs/zipline.utils.rst @@ -0,0 +1,56 @@ +:mod:`zipline.utils` subpackage +=============================== + +.. automodule:: zipline.utils.__init__ + :members: + :undoc-members: + :show-inheritance: + +:mod:`date_utils` Module +-------------------------- + +.. automodule:: zipline.utils.date_utils + :members: + :undoc-members: + :show-inheritance: + +:mod:`factory` Module +--------------------- + +.. automodule:: zipline.utils.factory + :members: + :undoc-members: + :show-inheritance: + +:mod:`protocol_units` Module +---------------------------- + +.. automodule:: zipline.utils.protocol_utils + :members: + :undoc-members: + :show-inheritance: + +:mod:`simfactory` Module +-------------------------- + +.. automodule:: zipline.utils.simfactory + :members: + :undoc-members: + :show-inheritance: + +:mod:`test_utils` Module +------------------------ + +.. automodule:: zipline.utils.test_utils + :members: + :undoc-members: + :show-inheritance: + +:mod:`tradingcalendar` Module +------------------------------ + +.. automodule:: zipline.utils.tradingcalendar + :members: + :undoc-members: + :show-inheritance: +