zipline/docs/source/index.rst

.. include:: ../../README.rst

.. toctree::
   :maxdepth: 1

   install
   beginner-tutorial
   bundles
   trading-calendars
   risk-and-perf-metrics
   development-guidelines
   appendix
   release-process
   releases
DOC: use sphinx docs 2015-11-04 23:32:34 +00:00			`.. include:: ../../README.rst`

			`.. toctree::`
			`:maxdepth: 1`

DOC: Add docs section on installation. 2015-11-29 20:07:23 +00:00			`install`
DOC: use sphinx docs 2015-11-04 23:32:34 +00:00			`beginner-tutorial`
ENH: Updates the cli, data bundles and extensions. Adds the data bundle concept which makes it easy for users to register loading functions to build out minute and daily data along with an assets db and adjustments db. By default we have provided a `quandl` bundle which pulls from the public domain WIKI dataset. Users may register new bundles by decorating an ingest function with `zipline.data.bundles.register(<name>)`. This also provides a `yahoo_equities` function for creating an ingestion function that will load a static set of assets from yahoo. The cli is now structured as a couple of subcommands and has been changed to `python -m zipline`. The old behavior of `run_algo.py` has been moved to the `run` subcommand. This is almost entirely the same except that it now takes the name of the data bundle to use, defaulting to `quandl`. The next subcommand is `ingest` which takes the name of a data bundle to ingest. This will run the loading machinery and write the data to a specified location that `run` can find. There is also a `clean` subcommand which deletes the data that was written with `ingest`. Extensions have also been added to zipline. This is an experimental feature where users can provide an extra set of python files to run at the start of the process. These can be used to configure aspects of zipline. Right now the only thing that is supported in an extension file is the registration of a new data bundle. 2016-04-20 18:52:12 +00:00			`bundles`
DOC: Add tutorial on creating a custom TradingCalendar (#2035) * DOC: Add tutorial on creating a custom TradingCalendar * DOC/STY: Formatting and fixup for the tutorial * MAINT: Suggested changes 2017-12-21 18:55:30 +00:00			`trading-calendars`
ENH: new risk metrics API 2018-01-06 01:24:50 +00:00			`risk-and-perf-metrics`
DOC: Add development guide .rst 2017-05-23 00:19:40 +00:00			`development-guidelines`
DOC: use sphinx docs 2015-11-04 23:32:34 +00:00			`appendix`
DOC: document the release process 2015-11-11 23:31:36 +00:00			`release-process`
DOC: Add development guide .rst 2017-05-23 00:19:40 +00:00			`releases`