Skip to content

Commit

Permalink
Added missing component of the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
benbaror committed Feb 14, 2018
1 parent f880697 commit a829287
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 2 deletions.
2 changes: 1 addition & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@ include CONTRIBUTING.rst
include LICENSE
include README.rst

include tox.ini .travis.yml appveyor.yml matplotlibrc
include tox.ini .travis.yml appveyor.yml matplotlibrc readthedocs.yml environment.yml

global-exclude *.py[cod] __pycache__ *.so *.dylib .ipynb*/* sandbox/*
30 changes: 29 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,34 @@ Overview
========

.. start-badges
.. list-table::
:stub-columns: 1

* - docs
- |docs|
* - tests
- | |travis| |appveyor| |requires|
| |codecov|
.. |docs| image:: https://readthedocs.org/projects/scrrpy/badge/?style=flat
:target: https://readthedocs.org/projects/scrrpy
:alt: Documentation Status

.. |travis| image:: https://travis-ci.org/benbaror/scrrpy.svg?branch=master
:alt: Travis-CI Build Status
:target: https://travis-ci.org/benbaror/scrrpy

.. |appveyor| image:: https://ci.appveyor.com/api/projects/status/github/benbaror/scrrpy?branch=master&svg=true
:alt: AppVeyor Build Status
:target: https://ci.appveyor.com/project/benbaror/scrrpy

.. |requires| image:: https://requires.io/github/benbaror/scrrpy/requirements.svg?branch=master
:alt: Requirements Status
:target: https://requires.io/github/benbaror/scrrpy/requirements/?branch=master

.. |codecov| image:: https://codecov.io/github/benbaror/scrrpy/coverage.svg?branch=master
:alt: Coverage Status
:target: https://codecov.io/github/benbaror/scrrpy

.. end-badges
Expand All @@ -20,7 +48,7 @@ Installation
Documentation
=============

.. https://scrrpy.readthedocs.io/
https://scrrpy.readthedocs.io/

Development
===========
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/scrrpy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,9 @@ scrrpy

.. automodule:: scrrpy
:members:

.. autoclass:: DRR
:members:

.. autoclass:: Cusp
:members:
1 change: 1 addition & 0 deletions environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@ dependencies:
- numpy
- numba
- cython
- h5py
- pip:
- vegas

0 comments on commit a829287

Please sign in to comment.