Cleanup docs, pep8ify, and backport dev simulator test

This commit is contained in:
Stephen Diehl
2012-02-23 15:32:17 -05:00
parent 6190da376a
commit e640aabf73
14 changed files with 251 additions and 507 deletions
+1 -1
View File
@@ -40,7 +40,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'QSim'
project = u'Zipline'
copyright = u'2012, Quantopian: jean, fawce, sdiehl'
# The version info for the project you're documenting, acts as replacement for
+7 -7
View File
@@ -1,4 +1,4 @@
.. QSim documentation master file, created by
.. Zipline documentation master file, created by
sphinx-quickstart on Wed Feb 8 15:29:56 2012.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
@@ -12,15 +12,15 @@ Contents:
modules.rst
messaging.rst
Quantopian Simulator: QSim
================================
Zipline
=======
Qsim runs backtests using asynchronous components and zeromq messaging for communication and coordination.
Zipline runs backtests using asynchronous components and zeromq messaging for communication and coordination.
Simulator is the heart of QSim, and the primary access point for creating, launching, and tracking simulations. You can find it in :py:class:`~zipline.core.Simulator`
Simulator is the heart of Zipline, and the primary access point for creating, launching, and tracking simulations. You can find it in :py:class:`~zipline.core.Simulator`
Simulator Sub-Components
==========================
========================
Each simulation contains numerous subcomponents, each operating asynchronously from all others, and communicating
via zeromq.
@@ -61,4 +61,4 @@ Indices and tables
* :ref:`modindex`
* :ref:`search`
.. _coverage: cover/index.html
.. _coverage: cover/index.html
-63
View File
@@ -1,63 +0,0 @@
============
zipline Package
============
QSim API
===========================
:mod:`zipline` Package
-------------------
.. automodule:: zipline.__init__
:members:
:undoc-members:
:show-inheritance:
:mod:`config` Module
--------------------
.. automodule:: zipline.config
:members:
:undoc-members:
:show-inheritance:
:mod:`core` Module
------------------
.. automodule:: zipline.core
:members:
:undoc-members:
:show-inheritance:
:mod:`messaging` Module
-----------------------
.. automodule:: zipline.messaging
:members:
:undoc-members:
:show-inheritance:
:mod:`sources` Module
---------------------
.. automodule:: zipline.sources
:members:
:undoc-members:
:show-inheritance:
:mod:`util` Module
------------------
.. automodule:: zipline.util
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
zipline.test
zipline.transforms
-19
View File
@@ -1,19 +0,0 @@
test Package
============
:mod:`client` Module
--------------------
.. automodule:: zipline.test.client
:members:
:undoc-members:
:show-inheritance:
:mod:`test_messaging` Module
----------------------------
.. automodule:: zipline.test.test_messaging
:members:
:undoc-members:
:show-inheritance:
-27
View File
@@ -1,27 +0,0 @@
transforms Package
==================
:mod:`core` Module
------------------
.. automodule:: zipline.transforms.core
:members:
:undoc-members:
:show-inheritance:
:mod:`merge` Module
-------------------
.. automodule:: zipline.transforms.merge
:members:
:undoc-members:
:show-inheritance:
:mod:`technical` Module
-----------------------
.. automodule:: zipline.transforms.technical
:members:
:undoc-members:
:show-inheritance:
+48
View File
@@ -9,6 +9,22 @@ zipline Package
:undoc-members:
:show-inheritance:
:mod:`cli` Module
-----------------
.. automodule:: zipline.cli
:members:
:undoc-members:
:show-inheritance:
:mod:`component` Module
-----------------------
.. automodule:: zipline.component
:members:
:undoc-members:
:show-inheritance:
:mod:`messaging` Module
-----------------------
@@ -17,6 +33,22 @@ zipline Package
:undoc-members:
:show-inheritance:
:mod:`monitor` Module
---------------------
.. automodule:: zipline.monitor
:members:
:undoc-members:
:show-inheritance:
:mod:`protocol` Module
----------------------
.. automodule:: zipline.protocol
:members:
:undoc-members:
:show-inheritance:
:mod:`sources` Module
---------------------
@@ -25,6 +57,14 @@ zipline Package
:undoc-members:
:show-inheritance:
:mod:`topology` Module
----------------------
.. automodule:: zipline.topology
:members:
:undoc-members:
:show-inheritance:
:mod:`util` Module
------------------
@@ -33,6 +73,14 @@ zipline Package
:undoc-members:
:show-inheritance:
:mod:`webui` Module
-------------------
.. automodule:: zipline.webui
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
+8
View File
@@ -17,3 +17,11 @@ test Package
:undoc-members:
:show-inheritance:
:mod:`test_sanity` Module
-------------------------
.. automodule:: zipline.test.test_sanity
:members:
:undoc-members:
:show-inheritance: