-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2 from bmorris3/docs
Adding sphinx documentation
- Loading branch information
Showing
73 changed files
with
9,815 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
# Compiled files | ||
*.py[cod] | ||
*.a | ||
*.o | ||
*.so | ||
__pycache__ | ||
|
||
# Ignore .c files by default to avoid including generated code. If you want to | ||
# add a non-generated .c extension, use `git add -f filename.c`. | ||
*.c | ||
|
||
# Other generated files | ||
*/version.py | ||
*/cython_version.py | ||
htmlcov | ||
.coverage | ||
MANIFEST | ||
.ipynb_checkpoints | ||
|
||
# Sphinx | ||
docs/api | ||
docs/_build | ||
|
||
# Eclipse editor project files | ||
.project | ||
.pydevproject | ||
.settings | ||
|
||
# Pycharm editor project files | ||
.idea | ||
|
||
# Floobits project files | ||
.floo | ||
.flooignore | ||
|
||
# Packages/installer info | ||
*.egg | ||
*.egg-info | ||
dist | ||
build | ||
eggs | ||
parts | ||
bin | ||
var | ||
sdist | ||
develop-eggs | ||
.installed.cfg | ||
distribute-*.tar.gz | ||
|
||
# Other | ||
.cache | ||
.tox | ||
.*.sw[op] | ||
*~ | ||
.project | ||
.pydevproject | ||
.settings | ||
|
||
# Mac OSX | ||
.DS_Store |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
[submodule "astropy_helpers"] | ||
url = https://github.com/astropy/astropy-helpers.git | ||
path = astropy_helpers | ||
branch = refs/heads/v3.2.1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
conda: | ||
file: .rtd-environment.yml | ||
|
||
python: | ||
setup_py_install: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
name: heliosk | ||
|
||
channels: | ||
- astropy | ||
|
||
dependencies: | ||
- python>=3.5 | ||
- astropy | ||
- Cython | ||
- matplotlib | ||
- numpy | ||
- sphinx-astropy | ||
# - pip: | ||
# - dependency_from_pip |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,172 @@ | ||
# We set the language to c because python isn't supported on the MacOS X nodes | ||
# on Travis. However, the language ends up being irrelevant anyway, since we | ||
# install Python ourselves using conda. | ||
language: c | ||
|
||
os: | ||
- linux | ||
|
||
# The apt packages below are needed for sphinx builds. A full list of packages | ||
# that can be included can be found here: | ||
# | ||
# https://github.com/travis-ci/apt-package-whitelist/blob/master/ubuntu-precise | ||
|
||
addons: | ||
apt: | ||
packages: | ||
- graphviz | ||
|
||
|
||
stage: Comprehensive tests | ||
|
||
stages: | ||
# Do the style check and a single test job, don't proceed if it fails | ||
- name: Initial tests | ||
# Test docs, astropy dev, and without optional dependencies | ||
- name: Comprehensive tests | ||
# Slow tests that should only run if comprehensive ones passed | ||
- name: Slow tests | ||
# These will only run when cron is opted in | ||
- name: Cron tests | ||
if: type = cron | ||
|
||
|
||
env: | ||
global: | ||
# The following versions are the 'default' for tests, unless | ||
# overridden underneath. They are defined here in order to save having | ||
# to repeat them for all configurations. | ||
- PYTHON_VERSION=3.7 | ||
- NUMPY_VERSION=stable | ||
- ASTROPY_VERSION=stable | ||
- MAIN_CMD='python setup.py' | ||
- SETUP_CMD='test' | ||
- EVENT_TYPE='pull_request push' | ||
|
||
|
||
# List runtime dependencies for the package that are available as conda | ||
# packages here. | ||
- CONDA_DEPENDENCIES='' | ||
- CONDA_DEPENDENCIES_DOC='sphinx-astropy' | ||
|
||
# List other runtime dependencies for the package that are available as | ||
# pip packages here. | ||
- PIP_DEPENDENCIES='' | ||
|
||
# Conda packages for affiliated packages are hosted in channel | ||
# "astropy" while builds for astropy LTS with recent numpy versions | ||
# are in astropy-ci-extras. If your package uses either of these, | ||
# add the channels to CONDA_CHANNELS along with any other channels | ||
# you want to use. | ||
- CONDA_CHANNELS='astropy' | ||
|
||
# If there are matplotlib or other GUI tests, uncomment the following | ||
# line to use the X virtual framebuffer. | ||
# - SETUP_XVFB=True | ||
|
||
# If you want to ignore certain flake8 errors, you can list them | ||
# in FLAKE8_OPT, for example: | ||
# - FLAKE8_OPT='--ignore=E501' | ||
- FLAKE8_OPT='' | ||
|
||
matrix: | ||
|
||
# Don't wait for allowed failures | ||
fast_finish: true | ||
|
||
include: | ||
# Make sure that egg_info works without dependencies | ||
- stage: Initial tests | ||
env: PYTHON_VERSION=3.7 SETUP_CMD='egg_info' | ||
|
||
# Try MacOS X, usually enough only to run from cron as hardly there are | ||
# issues that are not picked up by a linux worker | ||
- os: osx | ||
stage: Cron tests | ||
env: SETUP_CMD='test' EVENT_TYPE='cron' | ||
|
||
# Do a coverage test. | ||
- os: linux | ||
stage: Initial tests | ||
env: SETUP_CMD='test --coverage' | ||
|
||
# Check for sphinx doc build warnings - we do this first because it | ||
# may run for a long time | ||
- os: linux | ||
env: SETUP_CMD='build_docs -w' | ||
CONDA_DEPENDENCIES=$CONDA_DEPENDENCIES_DOC | ||
|
||
# Now try Astropy dev with the latest Python and LTS with and 3.x. | ||
- os: linux | ||
env: ASTROPY_VERSION=development | ||
EVENT_TYPE='pull_request push cron' | ||
- os: linux | ||
env: PYTHON_VERSION=3.6 ASTROPY_VERSION=lts NUMPY_VERSION=1.13 | ||
|
||
# Add a job that runs from cron only and tests against astropy dev and | ||
# numpy dev to give a change for early discovery of issues and feedback | ||
# for both developer teams. | ||
- os: linux | ||
stage: Cron tests | ||
env: ASTROPY_VERSION=development NUMPY_VERSION=development | ||
EVENT_TYPE='cron' | ||
|
||
# Try on Windows. | ||
- os: windows | ||
stage: Slow tests | ||
env: SETUP_CMD='test' | ||
|
||
# Try all python versions and Numpy versions. Since we can assume that | ||
# the Numpy developers have taken care of testing Numpy with different | ||
# versions of Python, we can vary Python and Numpy versions at the same | ||
# time. | ||
|
||
- os: linux | ||
env: PYTHON_VERSION=3.6 NUMPY_VERSION=1.14 | ||
- os: linux | ||
env: NUMPY_VERSION=1.15 | ||
|
||
# Do a PEP8 test with flake8 | ||
- os: linux | ||
stage: Initial tests | ||
env: MAIN_CMD='flake8 heliosk --count --show-source --statistics $FLAKE8_OPT' SETUP_CMD='' | ||
|
||
allow_failures: | ||
# Do a PEP8 test with flake8 | ||
# (do allow to fail unless your code completely compliant) | ||
# - os: linux | ||
# stage: Initial tests | ||
# env: MAIN_CMD='flake8 heliosk --count --show-source --statistics $FLAKE8_OPT' SETUP_CMD='' | ||
|
||
install: | ||
|
||
# We now use the ci-helpers package to set up our testing environment. | ||
# This is done by using Miniconda and then using conda and pip to install | ||
# dependencies. Which dependencies are installed using conda and pip is | ||
# determined by the CONDA_DEPENDENCIES and PIP_DEPENDENCIES variables, | ||
# which should be space-delimited lists of package names. See the README | ||
# in https://github.com/astropy/ci-helpers for information about the full | ||
# list of environment variables that can be used to customize your | ||
# environment. In some cases, ci-helpers may not offer enough flexibility | ||
# in how to install a package, in which case you can have additional | ||
# commands in the install: section below. | ||
|
||
- git clone --depth 1 git://github.com/astropy/ci-helpers.git | ||
- source ci-helpers/travis/setup_conda.sh | ||
|
||
# As described above, using ci-helpers, you should be able to set up an | ||
# environment with dependencies installed using conda and pip, but in some | ||
# cases this may not provide enough flexibility in how to install a | ||
# specific dependency (and it will not be able to install non-Python | ||
# dependencies). Therefore, you can also include commands below (as | ||
# well as at the start of the install section or in the before_install | ||
# section if they are needed before setting up conda) to install any | ||
# other dependencies. | ||
|
||
script: | ||
- $MAIN_CMD $SETUP_CMD | ||
|
||
after_success: | ||
# If coveralls.io is set up for this package, uncomment the line below. | ||
# The coveragerc file may be customized as needed for your package. | ||
# - if [[ $SETUP_CMD == *coverage* ]]; then coveralls --rcfile='heliosk/tests/coveragerc'; fi |
Oops, something went wrong.