Skip to content

Commit

Permalink
doc for installation
Browse files Browse the repository at this point in the history
  • Loading branch information
GreatYYX committed Aug 22, 2018
1 parent ae94a25 commit 0af0669
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,14 @@ Tutorial
.. toctree::
:maxdepth: 2

installation.rst
overview.rst


API Reference
-------------

.. toctree::
:maxdepth: 2
:maxdepth: 3

modules.rst
54 changes: 54 additions & 0 deletions docs/installation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
Installation
============

.. note::

RLTK only supports Python 3 and it's tested under Python 3.6.

pip
----

Using pip to install::

pip install rltk

If you want to update RLTK::

pip install -U rltk

Generally, it's recommended to install packages in a virtual environment::

virtualenv rltk_env
source activate rltk_env
pip install rltk

Install from source
-------------------

The other way to install RLTK is to clone from GitHub repository and build it from source::

git clone https://github.com/usc-isi-i2/rltk.git
cd rltk

virtualenv rltk_env
source activate rltk_env
pip install -e .

Run tests
---------

RLTK uses `pytest <https://pytest.org/>`_ for unit tests. To run them, simply do following command from the root of rltk package::

pytest

If you need more detailed information, do::

pytest -v --color=yes

Build documentation
-------------------

Documentation is powered by `Sphinx <http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_ , to generate it on your local, please run::

cd docs
make html # the generated doc is located at _build/html/index.html

0 comments on commit 0af0669

Please sign in to comment.