Skip to content

Commit

Permalink
documentation edits
Browse files Browse the repository at this point in the history
  • Loading branch information
dereneaton committed Nov 5, 2015
1 parent 73c7a33 commit c7d7d0c
Show file tree
Hide file tree
Showing 6 changed files with 85 additions and 6 deletions.
40 changes: 40 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
sudo: true
language: python
python:
- "2.7"
#- "3.3"
install:
- env | sort
- wget https://repo.continuum.io/miniconda/Miniconda-latest-Linux-x86_64.sh -O miniconda.sh
- bash miniconda.sh -b -p $HOME/miniconda
- export PATH="$HOME/miniconda/bin:$PATH"
- hash -r
- conda config --set always_yes yes --set changeps1 no
- conda config --add channels dsdale24
- conda update -q conda
- conda info -a
- conda create -q -n test-environment python=$TRAVIS_PYTHON_VERSION mock numpy pip
- source activate test-environment
- if [[ "$TRAVIS_PYTHON_VERSION" == "2.7" ]]; then
conda install h5py
sudo apt-get update -qq;
sudo apt-get install -y python-gtk2 wget;
export SITE_PACKAGES="$HOME/miniconda/envs/test-environment/lib/python$TRAVIS_PYTHON_VERSION/site-packages/";
ln -s /usr/lib/python2.7/dist-packages/glib/ $SITE_PACKAGES;
ln -s /usr/lib/python2.7/dist-packages/gobject/ $SITE_PACKAGES;
ln -s /usr/lib/python2.7/dist-packages/gtk-2.0* $SITE_PACKAGES;
ln -s /usr/lib/python2.7/dist-packages/pygtk.pth $SITE_PACKAGES;
ln -s /usr/lib/python2.7/dist-packages/cairo $SITE_PACKAGES;
fi
- pip install behave "colormath>=2.1.0" coverage coveralls nose-exclude
- wget http://johnvansickle.com/ffmpeg/releases/ffmpeg-release-64bit-static.tar.xz
- mkdir ffmpeg
- tar xf ffmpeg-release-64bit-static.tar.xz --strip-components 1 -C ffmpeg
- export PATH=$TRAVIS_BUILD_DIR/ffmpeg:$PATH
script:
- coverage run --source toyplot --omit toyplot/testing.py -m nose --exclude-dir toyplot
- coverage run --append --source toyplot --omit toyplot/testing.py -m behave
- coverage report
- python backend-report.py
after_script:
- coveralls
3 changes: 2 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,11 @@ Interactive assembly and analysis of RAD-seq data sets.
Tutorials
---------

Documentation is in the works, for now there are working example tutorials_.
Documentation is in the works_, for now there are working example tutorials_.

.. _tutorials: http://nbviewer.ipython.org/github/dereneaton/ipyrad/tree/master/tests/

.. _works: http://ipyrad.readthedocs.org/en/latest/

Installation
------------
Expand Down
1 change: 1 addition & 0 deletions conda.recipe/bld.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
python setup.py install
27 changes: 27 additions & 0 deletions conda.recipe/meta.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
package:
name: ipyrad
version: {{ environ['GIT_DESCRIBE_TAG'] }}

source:
git_url: ../

build:
script: python setup.py install
number: {{ environ.get('GIT_DESCRIBE_NUMBER', 0) }}

requirements:
build:
- ipython
- ipyparallel
- cython
- scipy
- numpy >=1.7
- h5py
run:
- numpy >=1.7


about:
home: http://github.com/dereneaton/ipyrad
license: GPLv3
summary: Interactive assembly and analysis of RAD-seq data sets.
15 changes: 14 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,20 @@ def __getattr__(cls, name):
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = []
extensions = ["sphinx.ext.autodoc",
"sphinxcontrib.napolean"]

# Napoleon settings
napoleon_google_docstring = True
napoleon_numpy_docstring = True
napoleon_include_private_with_doc = False
napoleon_include_special_with_doc = True
napoleon_use_admonition_for_examples = False
napoleon_use_admonition_for_notes = False
napoleon_use_admonition_for_references = False
napoleon_use_ivar = False
napoleon_use_param = True
napoleon_use_rtype = True

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down
5 changes: 1 addition & 4 deletions docs/test_rad.rst
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,6 @@ sample that will be stored in the Assembly object.

.. code:: python
%%time
## run step 1 to demultiplex the data
data1.step1()
Expand All @@ -166,7 +165,7 @@ sample that will be stored in the Assembly object.
.. parsed-literal::
state reads_raw reads_filtered clusters_total clusters_kept \
state reads_raw reads_filtered clusters_total clusters_kept
1A_0 1 20099 NaN NaN NaN
1B_0 1 19977 NaN NaN NaN
1C_0 1 20114 NaN NaN NaN
Expand All @@ -179,8 +178,6 @@ sample that will be stored in the Assembly object.
1C_0 NaN NaN NaN
1D_0 NaN NaN NaN
2E_0 NaN NaN NaN
CPU times: user 931 ms, sys: 66.6 ms, total: 998 ms
Wall time: 8.18 s
Step 2: Filter reads
Expand Down

0 comments on commit c7d7d0c

Please sign in to comment.