From 8f0f253aebd4cf31144d54b7e3c2c928613921be Mon Sep 17 00:00:00 2001 From: Tony S Yu Date: Sat, 16 Jul 2011 00:26:16 -0400 Subject: [PATCH 1/4] Fix docstring so Sphinx doesn't complain about indentation. Same indentation fix in 3 places, but only one warning fixed because 2 of the fixes are private functions. --- scikits/image/filter/tv_denoise.py | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) 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. From cba0ec648455fff69fa273f08ce7b93740513b8f Mon Sep 17 00:00:00 2001 From: Tony S Yu Date: Mon, 18 Jul 2011 01:05:03 -0400 Subject: [PATCH 2/4] Remove index.html template and use markup in index.txt instead. Using reStructuredText to build the front page is a bit easier to maintain. --- doc/source/_templates/index.html | 88 -------------------------------- doc/source/conf.py | 2 +- doc/source/index.txt | 39 +++++++++++++- 3 files changed, 38 insertions(+), 91 deletions(-) delete mode 100644 doc/source/_templates/index.html 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

- -
-

- - Overview
- - Introduction to {{project}}. -

- -

- - Installation Steps
- - How to install {{project}}. -

- -

- - Contribute
- - Take part in development. -

- - 		- -

- - API Reference (changes)
- - Documentation for the functions included in {{project}}. -

- -

- - User Guide
- - Usage guidelines. -

- -

- - License Info
- - Conditions on the use and redistribution of this package. -

- -
- -

Indices and Tables

- - -
-

- - Table of Contents
- - Lists all sections and subsections. -

- -

- - Search Page
- - Search this documentation. -

- - 		- -

- - Index
- - All functions, classes, terms. -

- -
- -{% 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..8ed4ff33 100644 --- a/doc/source/index.txt +++ b/doc/source/index.txt @@ -1,3 +1,38 @@ -.. toctree:: +************* +scikits.image +************* - /api/api +This SciKit_ is an image processing toolbox for SciPy_. + +.. _SciKit: http://scikits.appspot.com +.. _SciPy: http://www.scipy.org + + +Sections +======== + +`Overview `_ + Introduction to scikits.image. +`Installation Steps `_ + How to install scikits.image. +`Contribute `_ + Take part in development. +`API Reference `_ (`changes `_) + Documentation for the functions included in scikits.image. +`User Guide `_ + Usage guidelines. +`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. From e7ad3d58efa6209363e7e8e152e6d73b83b11bfb Mon Sep 17 00:00:00 2001 From: Tony S Yu Date: Mon, 18 Jul 2011 01:38:56 -0400 Subject: [PATCH 3/4] Add version number to index page of docs --- doc/source/index.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/source/index.txt b/doc/source/index.txt index 8ed4ff33..f70dc86e 100644 --- a/doc/source/index.txt +++ b/doc/source/index.txt @@ -1,6 +1,6 @@ -************* -scikits.image -************* +**************************** +scikits.image |version| docs +**************************** This SciKit_ is an image processing toolbox for SciPy_. From 1f311418371b3560ad5cd922122762aef0f87662 Mon Sep 17 00:00:00 2001 From: Tony S Yu Date: Mon, 18 Jul 2011 11:15:10 -0400 Subject: [PATCH 4/4] Format front page so it looks similar to old template. --- doc/source/index.txt | 38 +++++++++++++++------- doc/source/themes/agogo/static/agogo.css_t | 8 +++++ 2 files changed, 34 insertions(+), 12 deletions(-) diff --git a/doc/source/index.txt b/doc/source/index.txt index f70dc86e..15b5b57e 100644 --- a/doc/source/index.txt +++ b/doc/source/index.txt @@ -11,18 +11,32 @@ This SciKit_ is an image processing toolbox for SciPy_. Sections ======== -`Overview `_ - Introduction to scikits.image. -`Installation Steps `_ - How to install scikits.image. -`Contribute `_ - Take part in development. -`API Reference `_ (`changes `_) - Documentation for the functions included in scikits.image. -`User Guide `_ - Usage guidelines. -`License Info `_ - Conditions on the use and redistribution of this package. +.. 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 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; }