DOC: Added autodoc generating links for all submodules

This commit is contained in:
Tobias Brandt
2012-11-14 14:29:50 +02:00
parent 220cc557df
commit b10bfc98a1
7 changed files with 220 additions and 12 deletions
+2 -2
View File
@@ -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
========================
+40
View File
@@ -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:
+23 -2
View File
@@ -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
---------------------
+40
View File
@@ -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:
+12 -8
View File
@@ -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
+47
View File
@@ -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:
+56
View File
@@ -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: