From 846744214f2710345a1712bf30503cf3f5dc4374 Mon Sep 17 00:00:00 2001 From: Ana Ruelas Date: Mon, 5 Jun 2017 16:09:36 -0400 Subject: [PATCH] DOC: Include PipelineEngine in documentation --- docs/source/appendix.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/source/appendix.rst b/docs/source/appendix.rst index 6cd1c619..b4565432 100644 --- a/docs/source/appendix.rst +++ b/docs/source/appendix.rst @@ -242,6 +242,25 @@ Built-in Factors .. autoclass:: zipline.pipeline.factors.WeightedAverageValue :members: +Pipeline Engine +``````````````` + +.. autoclass:: zipline.pipeline.engine.PipelineEngine + :members: run_pipeline, run_chunked_pipeline + :member-order: bysource + +.. autoclass:: zipline.pipeline.engine.SimplePipelineEngine + :members: __init__, run_pipeline, run_chunked_pipeline + :member-order: bysource + +.. autofunction:: zipline.pipeline.engine.default_populate_initial_workspace + +Data Loaders +```````````` + +.. autoclass:: zipline.pipeline.loaders.equity_pricing_loader.USEquityPricingLoader + :members: __init__, from_files, load_adjusted_array + :member-order: bysource Asset Metadata ~~~~~~~~~~~~~~