New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: use sphinx docs #816

Closed
wants to merge 5 commits into
base: master
from

Conversation

Projects
None yet
5 participants
@llllllllll
Member

llllllllll commented Nov 4, 2015

edit: this also changes the readme to markdown so pypi renders it correctly and it can be included in the docs

@llllllllll llllllllll force-pushed the sphinx-docs branch 2 times, most recently from 70a40de to c91d545 Nov 4, 2015

@twiecki

This comment has been minimized.

Contributor

twiecki commented Nov 5, 2015

This is great. Couple of questions:

  • Can these be viewed anywhere?
  • Does it upload to gh-pages?
  • Do NBs get automatically converted to rst and included in the docs?
@llllllllll

This comment has been minimized.

Member

llllllllll commented Nov 5, 2015

The docs can be built into html, latex, man pages, and a bunch of other formats so I think they should be viewable anywhere. There is an included makefile and also a make.bat for building on windows (though I did not test this).

I am not sure about the uploading of these docs. I know readthedocs accepts sphinx projects as that is how many other projects on readthedocs are documented. What is the process for deploying new documentation?

The notebooks did not automatically get converted; I ran nbconvert in --to rst. This could have been automated but there was some manual cleanup needed after the conversion. For example, the levels for each section were too high so I needed to change some of them. There was also some weird output in the terminal output cells that needed to be stripped. The raw notebook is still included though.

* New user defined method: ``before_trading_start``.
* New api function: ``schedule_function``.
* Pipeline API.
* Support for trading futures.

This comment has been minimized.

@richafrank

richafrank Nov 5, 2015

Member

Other new api functions: get_environment, set_max_leverage, set_do_not_order_list

@twiecki

This comment has been minimized.

Contributor

twiecki commented Nov 5, 2015

readthedocs is more trouble than it's worth. I'd just go with gh-pages.

@llllllllll

This comment has been minimized.

Member

llllllllll commented Nov 5, 2015

Okay. Do you know how to update our docs on zipline.io?

@twiecki

This comment has been minimized.

Contributor

twiecki commented Nov 5, 2015

Not sure if this is helpful at all: http://docs.hisparc.nl/sapphire/README.html mkdocs had a gh-deploy command built-in.

Experimental features are subject to change.
* Adds new Pipeline API. The pipeline AAPI is a high-level declarative API for
representing trailing window computaions on large datasets (:issue:`630`).

This comment has been minimized.

@richafrank
Enhancements
~~~~~~~~~~~~
* Account object: Adds an account object to conext to track information about

This comment has been minimized.

@ssanderson

ssanderson Nov 6, 2015

Member

context

README.rst Outdated
|Code quality|
Zipline is a Pythonic algorithmic trading library. The system is
fundamentally event-driven and a close approximation of how live-trading

This comment has been minimized.

@llllllllll

llllllllll Nov 6, 2015

Member

should we still say "aprproximation", it is how our live-trading works

README.rst Outdated
fundamentally event-driven and a close approximation of how live-trading
systems operate.
Zipline is currently used in production as the backtesting engine

This comment has been minimized.

@llllllllll

llllllllll Nov 6, 2015

Member

should we mention live trading too?

community! <https://groups.google.com/forum/#!forum/zipline>`__
Want to contribute? See our `open
requests <https://github.com/quantopian/zipline/wiki/Contribution-Requests>`__

This comment has been minimized.

@llllllllll

llllllllll Nov 6, 2015

Member

audit this, we can do this whenever since it is the wiki

README.rst Outdated
Currently supported platforms include:
- Windows 32-bit (can be 64-bit Windows but has to be 32-bit Anaconda)

This comment has been minimized.

@ssanderson

ssanderson Nov 6, 2015

Member

Is this still true?

This comment has been minimized.

@llllllllll

llllllllll Nov 6, 2015

Member

I think I am dropping windows for now. We have not tested this so we cannot make any claims

README.rst Outdated
Installation
============
The easiest way to install Zipline is via ``conda`` which comes as part

This comment has been minimized.

@ssanderson

ssanderson Nov 6, 2015

Member

pip is probably easier until we upgrade the conda packages.

This comment has been minimized.

@llllllllll

llllllllll Nov 6, 2015

Member

I have moved pip to suggested method

Experimental features are subject to change.
* Adds new Pipeline API. The pipeline API is a high-level declarative API for
representing trailing window computaions on large datasets (:issue:`630`).

This comment has been minimized.

@abhijeetkalyan

abhijeetkalyan Nov 6, 2015

Member

Typo 'computaions' -> 'computations'

README.rst Outdated
If there are problems installing the dependencies or zipline we
recommend installing these packages via some other means. For Windows,
the `Enthought Python

This comment has been minimized.

@ssanderson

ssanderson Nov 6, 2015

Member

I don't think anyone we know of uses Enthought successfully with Zipline. We should probably point people on Windows to Anaconda.

README.rst Outdated
recommend installing these packages via some other means. For Windows,
the `Enthought Python
Distribution <http://www.enthought.com/products/epd.php>`__ includes
most of the necessary dependencies. On OSX, the `Scipy

This comment has been minimized.

@ssanderson

ssanderson Nov 6, 2015

Member

I'm not sure we need OSX-specific instructions.

README.rst Outdated
Dependencies
------------
- Python (2.7 or 3.3)

This comment has been minimized.

@ssanderson

ssanderson Nov 6, 2015

Member

We have many more dependencies than these now. I'm not sure it's worth listing all of them in the readme.

llllllllll added some commits Nov 6, 2015

@llllllllll

This comment has been minimized.

Member

llllllllll commented Nov 6, 2015

merged: 1955146

@llllllllll llllllllll closed this Nov 6, 2015

@llllllllll llllllllll deleted the sphinx-docs branch Nov 12, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment