diff --git a/docs/source/conf.py b/docs/source/conf.py index 3e90f91c..dd0304d0 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -94,6 +94,6 @@ intersphinx_mapping = { 'pandas': ('http://pandas.pydata.org/pandas-docs/stable/', None), } -doctest_global_setup = "import zipline" +doctest_global_setup = "import catalyst" todo_include_todos = True diff --git a/docs/source/install.rst b/docs/source/install.rst index b13e8dfd..57fb711f 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -38,6 +38,7 @@ Python`_ provides an `excellent tutorial on virtualenv version: .. code-block:: bash + $ virtualenv catalyst-venv $ source ./catalyst-venv/bin/activate $ pip install enigma-catalyst @@ -66,15 +67,17 @@ On `Arch Linux`_, you can acquire the additional dependencies via ``pacman``: $ pacman -S lapack gcc gcc-fortran pkg-config -There are also AUR packages available for installing `Python 3.4 -`_ (Arch's default python is now -3.5, but Zipline only currently supports 3.4), and `ta-lib -`_, an optional Zipline dependency. -Python 2 is also installable via: +.. Commenting it out until Catalyst fully supports Python 3.X +.. +.. There are also AUR packages available for installing `Python 3.4 +.. `_ (Arch's default python is now +.. 3.5, but Zipline only currently supports 3.4), and `ta-lib +.. `_, an optional Zipline dependency. +.. Python 2 is also installable via: -.. code-block:: bash +.. - $ pacman -S python2 +.. $ pacman -S python2 OSX ~~~ @@ -104,20 +107,20 @@ For windows, the easiest and best supported way to install zipline is to use Installing with ``conda`` ------------------------- -Another way to install Zipline is via the ``conda`` package manager, which +Another way to install Catalyst is via the ``conda`` package manager, which comes as part of Continuum Analytics' `Anaconda `_ distribution. The primary advantage of using Conda over ``pip`` is that conda natively understands the complex binary dependencies of packages like ``numpy`` and -``scipy``. This means that ``conda`` can install Zipline and its dependencies -without requiring the use of a second tool to acquire Zipline's non-Python +``scipy``. This means that ``conda`` can install Catalyst and its dependencies +without requiring the use of a second tool to acquire Catalyst's non-Python dependencies. For instructions on how to install ``conda``, see the `Conda Installation Documentation `_ -Once conda has been set up you can install Zipline from our ``Quantopian`` +Once conda has been set up you can install Catalyst from our ``Quantopian`` channel: .. code-block:: bash diff --git a/etc/requirements_docs.txt b/etc/requirements_docs.txt index 400b3108..362d4725 100644 --- a/etc/requirements_docs.txt +++ b/etc/requirements_docs.txt @@ -1,4 +1,3 @@ Sphinx>=1.3.2 numpydoc>=0.5.0 sphinx-autobuild==0.6.0 -enigma-catalyst # readthedocs.org