Skip to content

Commit

Permalink
Add content to docs homepage
Browse files Browse the repository at this point in the history
  • Loading branch information
banesullivan committed Aug 7, 2018
1 parent 10d9a37 commit 74cafe5
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ $ pip install espatools

## Usage

We think `espatools` is easy to use; give it a try and let us know what you think!
We think `espatools` is easy to use; give it a try and let us know what you think as this is just the beta-release!

See [this Jupyter Notebook](https://github.com/OpenGeoVis/espatools/blob/master/Example.ipynb) for a demonstration of some simple plotting after reading Landsat imagery.

Expand Down
43 changes: 39 additions & 4 deletions docs/index_base.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,50 @@
Welcome to ``espatools``'s code docs!
=====================================
ESPA Tools
==========

This website hosts the code documentation for the ``espatools`` python package found
on `GitHub`_ and `PyPI`_. This website documents the code so that users
.. image:: https://readthedocs.org/projects/espatools/badge/?version=latest
:target: https://espatools.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

.. image :: https://img.shields.io/pypi/v/espatools.svg
:target: https://pypi.org/project/espatools/
:alt: PyPI
.. image :: https://travis-ci.org/OpenGeoVis/espatools.svg?branch=master
:target: https://travis-ci.org/OpenGeoVis/espatools
:alt: Build Status
An open-source Python package for simple loading of Landsat imagery as NumPy arrays. `Learn more about the API`_. This website hosts the code documentation for the ``espatools`` python package found on `GitHub`_ and `PyPI`_. This website documents the code so that users
have a convenient and familiar means of searching through the library to understand
the backend of the features they are using.


.. _GitHub: https://github.com/OpenGeoVis/espatools/
.. _PyPI: https://pypi.org/project/espatools/

.. _Learn more about the API: https://espatools.readthedocs.io/en/latest/

Install
-------

``espatools`` is available from `PyPI`_

.. _PyPI: https://pypi.org/project/espatools/

.. code-block:: bash
$ pip install espatools
Usage
-----

We think `espatools` is easy to use; give it a try and let us know what you think as this is just the beta-release! See `this Jupyter Notebook`_ for a demonstration of some simple plotting after reading Landsat imagery.

.. _this Jupyter Notebook: https://github.com/OpenGeoVis/espatools/blob/master/Example.ipynb




.. toctree::
:hidden:

Expand Down

0 comments on commit 74cafe5

Please sign in to comment.