Skip to content

Commit

Permalink
Consolidate README content in docs (#40)
Browse files Browse the repository at this point in the history
* Move features to index page  [ci skip]

Based on feedback, move the list of features into the index page and
drop them from the README.

* Drop README from docs  [ci skip]

As most of the content is already in the docs, the README doesn't need
to be published in the docs. So drop it from the index and remove the
README page.

* Make "Indices and tables" a subheading  [ci skip]

Looked weird when this was a heading of the same size as the title.
Especially with other subheadings present. So this fixes that issue.
  • Loading branch information
jakirkham committed Aug 31, 2018
1 parent d29831a commit 8ded24f
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 15 deletions.
11 changes: 0 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,3 @@ Distributed image processing

* Free software: BSD 3-Clause
* Documentation: https://dask-image.readthedocs.io.


Features
--------

* Support focuses on Dask Arrays.
* Provides support for loading image files.
* Implements commonly used N-D filters.
* Includes a few N-D Fourier filters.
* Provides some functions for working with N-D label images.
* Supports a few N-D morphological operators.
16 changes: 13 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,20 +1,30 @@
Image processing with Dask Arrays
=================================

Contents:
Features
--------

* Support focuses on Dask Arrays.
* Provides support for loading image files.
* Implements commonly used N-D filters.
* Includes a few N-D Fourier filters.
* Provides some functions for working with N-D label images.
* Supports a few N-D morphological operators.

Contents
--------

.. toctree::
:maxdepth: 1

Readme <readme>
installation
api
contributing
authors
history

Indices and tables
==================
------------------

* :ref:`genindex`
* :ref:`modindex`
Expand Down
1 change: 0 additions & 1 deletion docs/readme.rst

This file was deleted.

0 comments on commit 8ded24f

Please sign in to comment.