Skip to content

Commit

Permalink
Fix some documentation issues
Browse files Browse the repository at this point in the history
  • Loading branch information
jchodera committed Dec 31, 2016
1 parent d146e9c commit 7ab4bd2
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 12 deletions.
5 changes: 4 additions & 1 deletion docs/analysis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

.. currentmodule:: assaytools

.. note::
This section is under heavy construction!
For now, see the examples directory: https://github.com/choderalab/assaytools/tree/master/examples

Analysis Functions
==================

Expand All @@ -11,4 +15,3 @@ Here's an example ::

>>> import assaytools
>>> dataset = assaytools.load('dataset.xml')

24 changes: 19 additions & 5 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,26 @@
#import assaytools
#import assaytools.version

# Use mock to make our code think that numpy and scipy are available, even though they might not be available on readthedocs
import mock
import sys
try:
from unittest.mock import MagicMock
except ImportError:
from mock import Mock as MagicMock

class Mock(MagicMock):
@classmethod
def __getattr__(cls, name):
return MagicMock()

MOCK_MODULES = ['numpy', 'scipy', 'numpy.linalg', 'scipy.special', 'scipy.stats', 'pymc', 'pint']
for mod_name in MOCK_MODULES:
sys.modules[mod_name] = mock.Mock()
MOCK_MODULES = ['numpy', 'scipy', 'numpy.linalg', 'scipy.special', 'scipy.stats', 'pymc', 'pint', 'pandas']
sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)

# Use mock to make our code think that numpy and scipy are available, even though they might not be available on readthedocs
#import mock
#
#MOCK_MODULES = ['numpy', 'scipy', 'numpy.linalg', 'scipy.special', 'scipy.stats', 'pymc', 'pint']
#for mod_name in MOCK_MODULES:
# sys.modules[mod_name] = mock.Mock()

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
Expand Down
11 changes: 5 additions & 6 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,11 @@ Install with conda
------------------
.. _install-with-conda:

To install `AssayTools` with `conda <conda.pydata.org>`_`, use the following commands:
To install `AssayTools` and its dependencies with `conda <conda.pydata.org>`_`, use the following commands:

::
$ conda install -c omnia assaytools

.. note::
``conda`` will automatically all of the tricky dependencies from binary packages automatically!
This includes :mod:`pytables`, :mod:`numpy`, :mod:`scipy`, :mod:`pandas`, and :mod:`pymc`!
The easiest way to get ``conda`` is with the `Anaconda python distribution <https://store.continuum.io/cshop/anaconda/>`_, or its smaller version `Miniconda <http://conda.pydata.org/miniconda.html>`_.
$ conda install -c omnia assaytools

Install from source
-------------------
Expand All @@ -27,6 +23,7 @@ Install from source
You can install the latest development version of ``AssayTools`` from github via ``pip``:

::

$ pip install git+https://github.com/choderalab/assaytools.git

Testing Your Installation
Expand All @@ -37,9 +34,11 @@ Running the tests is a great way to verify that everything is working.
The test suite uses `nose <https://nose.readthedocs.org/en/latest/>`_, which you can install via ``conda``:

::

$ conda install nose

Then, to run the tests:

::

$ nosetests -vv assaytools

0 comments on commit 7ab4bd2

Please sign in to comment.