Skip to content

Commit

Permalink
Trying to update documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
jason-neal committed Oct 22, 2016
1 parent 913efd8 commit 0dced37
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 9 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ One of these may better suit your needs

Wow A lot. I probably should not reinvent the wheel too much then...

It turns out that astropy/specutils is very similar to what I have created but its direction is uncertain at the moment and they do not use overloaded operators and will not implement in the foreseeable future.

## TO DO
Some tasks still to do:
Expand Down
19 changes: 10 additions & 9 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,29 +3,30 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
=============================================
Welcome to spectrum_overload's documentation!
====================================
=============================================
.. image:: https://travis-ci.org/jason-neal/spectrum_overload.svg?branch=develop
:target: https://travis-ci.org/jason-neal/spectrum_overload

.. image:: https://coveralls.io/repos/github/jason-neal/spectrum_overload/badge.svg?branch=develop
:target: https://coveralls.io/github/jason-neal/spectrum_overload?branch=develop
:target: https://coveralls.io/github/jason-neal/spectrum_overload?branch=develop


Contents:
spectrum_overload contains a spectrum class which contains overloaded operators.
This means that you can easily divide and subtract spectra from each other.

If the spectra are do not have the same wavelenght axis then it is automatially interpolated so that they are the same.


.. toctree::
:maxdepth: 2

.. automodule:: spectrum_overload

Spectrum Class
==============
quickstart
installation

A python class to contain a spectrum. The operators have been overloaded so that you can easily combine spectra.

.. autoclass:: spectrum_overload.Spectrum
:members:

Indices and tables
==================
Expand Down

0 comments on commit 0dced37

Please sign in to comment.