Skip to content

Commit

Permalink
Merge pull request #349 from bccp/v0.1.x-docs
Browse files Browse the repository at this point in the history
clean up legacy docs and tests
  • Loading branch information
nickhand committed Jun 10, 2017
2 parents 7aeca67 + c4a7ad6 commit 923f21e
Show file tree
Hide file tree
Showing 13 changed files with 307 additions and 273 deletions.
23 changes: 12 additions & 11 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,37 +27,38 @@ before_install:
- ./miniconda.sh -b -p $HOME/miniconda
- export PATH=$HOME/miniconda/bin:$PATH
- conda update --yes conda
# set the c++ and fortran compilers
- export CXX=g++-4.8

# set the c++ and fortran compilers
- export CXX=g++-4.8
- export F90=gfortran-4.8

install:
- conda create --yes -n test python=$TRAVIS_PYTHON_VERSION
- source activate test

# base python setup
- conda install --yes numpy=$NUMPY_VERSION nose cython mpi4py h5py pandas scipy pytables pyyaml astropy numba dask
- pip install pytest pytest-cov pytest-pipeline coveralls

# test optional HOD data sources
- pip install halotools
- pip install halotools==0.4 # pin on 0.1.x branch

# test optional Zeldovich data source
- conda install --yes "swig>=3.0"
- pip install --no-cache-dir classylss # ignore cache due to binaries

# nbodykit and requirements
- pip install --pre pfft-python kdcount mpsort pmesh sharedmem bigfile --no-deps
- pip install --pre pfft-python kdcount mpsort sharedmem bigfile --no-deps
- pip install pmesh==0.1.23 # pin on 0.1.x branch
- pip install --pre -r requirements.txt -e . # develop mode to track coverage of subproccess

script:
- py.test nbodykit --cov=nbodykit --cov-report term-missing
- bash check_tag.sh nbodykit/version.py

after_success:
- coveralls

deploy:
- provider: pypi
distributions: sdist
Expand All @@ -68,6 +69,6 @@ deploy:
on:
tags : true
condition : $TRAVIS_PYTHON_VERSION = "2.7"

#notifications:
# email: false
12 changes: 6 additions & 6 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,13 @@ clean:
rm -rf api

html-setup: apidoc plugins-apidoc plugins-list

plugins-apidoc: apidoc
echo ".. include:: nbodykit.plugins.rst" > api/plugins_ref.rst
echo ".. include:: nbodykit.core.rst" > api/plugins_ref.rst

apidoc:
apidoc:
bash apidoc.sh

plugins-list:
python generate_plugins_list.py

Expand All @@ -69,8 +69,8 @@ html: html-setup
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

gh-pages:
./ghp-import -n -p $(BUILDDIR)/html/
gh-pages:
./ghp-import -n -p $(BUILDDIR)/html/

dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
Expand Down
2 changes: 1 addition & 1 deletion docs/apidoc.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
if ! python -c 'import numpydoc'; then easy_install --user numpydoc; fi
if ! python -c 'import sphinx'; then easy_install --user sphinx; fi

sphinx-apidoc -H "API reference" -M -e -f -o api/ ../nbodykit ../nbodykit/extern
sphinx-apidoc -H "API reference" -M -e -f -o api/ ../nbodykit ../nbodykit/extern ../nbodykit/test
11 changes: 2 additions & 9 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,6 @@
import os
import shlex

import mock
MOCK_MODULES = ['mpsort', 'mpi4py', 'scipy', 'scipy.interpolate', 'h5py', 'bigfile',
'kdcount', 'pmesh', 'pmesh.particlemesh', 'pmesh.domain', 'pytest',
'astropy']
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
# documentation root, use os.path.abspath to make it absolute, like shown here.
Expand Down Expand Up @@ -148,10 +141,10 @@ def setup(app):
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
else:

# do the html setup
os.system("make html-setup")

#html_theme = 'nature'

# Theme options are theme-specific and customize the look and feel of a theme
Expand Down
Loading

0 comments on commit 923f21e

Please sign in to comment.