diff --git a/doc/source/_templates/index.html b/doc/source/_templates/index.html deleted file mode 100644 index 834c7975..00000000 --- a/doc/source/_templates/index.html +++ /dev/null @@ -1,88 +0,0 @@ -{% extends "layout.html" %} -{% set title = 'Home' %} -{% block body %} - -

{{ docstitle }}

-

This SciKit is an - image processing toolbox for SciPy.

- -

Sections

- -
- - - - - - - - - - - - - - -
- -

Indices and Tables

- - -
- - - - - - - - -
- -{% endblock %} diff --git a/doc/source/conf.py b/doc/source/conf.py index febe1fe1..34694a1d 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -148,7 +148,7 @@ html_static_path = ['_static'] # Additional templates that should be rendered to pages, maps page names to # template names. -html_additional_pages = {'index': 'index.html'} +# html_additional_pages = {} # If false, no module index is generated. #html_use_modindex = True diff --git a/doc/source/index.txt b/doc/source/index.txt index a487b092..15b5b57e 100644 --- a/doc/source/index.txt +++ b/doc/source/index.txt @@ -1,3 +1,52 @@ -.. toctree:: +**************************** +scikits.image |version| docs +**************************** - /api/api +This SciKit_ is an image processing toolbox for SciPy_. + +.. _SciKit: http://scikits.appspot.com +.. _SciPy: http://www.scipy.org + + +Sections +======== + +.. list-table:: + :class: contentstable + + * - `Overview `_ + + Introduction to scikits.image. + + - `API Reference `_ (`changes `_) + + Documentation for the functions included in scikits.image. + + * - `Installation Steps `_ + + How to install scikits.image. + + - `User Guide `_ + + Usage guidelines. + + * - `Contribute `_ + + Take part in development. + + - `License Info `_ + + Conditions on the use and redistribution of this package. + + +Indices and Tables +================== + +`Table of Contents `_ + Lists all sections and subsections. + +:ref:`search` + Search this documentation. + +:ref:`genindex` + All functions, classes, terms. diff --git a/doc/source/themes/agogo/static/agogo.css_t b/doc/source/themes/agogo/static/agogo.css_t index 443e66c8..af6f0a76 100644 --- a/doc/source/themes/agogo/static/agogo.css_t +++ b/doc/source/themes/agogo/static/agogo.css_t @@ -426,6 +426,14 @@ table.contentstable p.biglink { line-height: 150%; } +table.contentstable { + border-style: none; +} + +table.contentstable td, table.contentstable th { + border-style: none; +} + a.biglink { font-size: 1.3em; } diff --git a/scikits/image/filter/tv_denoise.py b/scikits/image/filter/tv_denoise.py index f2987b55..557f529d 100644 --- a/scikits/image/filter/tv_denoise.py +++ b/scikits/image/filter/tv_denoise.py @@ -15,8 +15,9 @@ def _tv_denoise_3d(im, weight=100, eps=2.e-4, keep_type=False, n_iter_max=200): eps: float, optional relative difference of the value of the cost function that determines - the stop criterion. The algorithm stops when - (E_(n-1) - E_n) < eps * E_0 + the stop criterion. The algorithm stops when: + + (E_(n-1) - E_n) < eps * E_0 keep_type: bool, optional (False) whether the output has the same dtype as the input array. @@ -107,8 +108,9 @@ def _tv_denoise_2d(im, weight=50, eps=2.e-4, keep_type=False, n_iter_max=200): eps: float, optional relative difference of the value of the cost function that determines - the stop criterion. The algorithm stops when - (E_(n-1) - E_n) < eps * E_0 + the stop criterion. The algorithm stops when: + + (E_(n-1) - E_n) < eps * E_0 keep_type: bool, optional (False) whether the output has the same dtype as the input array. @@ -205,8 +207,9 @@ def tv_denoise(im, weight=50, eps=2.e-4, keep_type=False, n_iter_max=200): eps: float, optional relative difference of the value of the cost function that - determines the stop criterion. The algorithm stops when - (E_(n-1) - E_n) < eps * E_0 + determines the stop criterion. The algorithm stops when: + + (E_(n-1) - E_n) < eps * E_0 keep_type: bool, optional (False) whether the output has the same dtype as the input array.