From 1455874c3c3b94c199702f57c805f82c65c32ed2 Mon Sep 17 00:00:00 2001 From: emmanuelle Date: Thu, 10 Dec 2015 23:36:27 +0100 Subject: [PATCH 1/2] Documented required version of sphinx --- DEPENDS.txt | 7 +++++++ doc/README.md | 2 +- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/DEPENDS.txt b/DEPENDS.txt index 2130e21d..2c2aeb7d 100644 --- a/DEPENDS.txt +++ b/DEPENDS.txt @@ -56,3 +56,10 @@ Testing requirements A Python Unit Testing Framework * `Coverage.py `__ A tool that generates a unit test code coverage report + + +Documentation requirements +-------------------------- + +`sphinx >= 1.3 `_ is required to build the +documentation. diff --git a/doc/README.md b/doc/README.md index d9fec89a..d11b92dd 100644 --- a/doc/README.md +++ b/doc/README.md @@ -2,7 +2,7 @@ To build docs, run `make` in this directory. `make help` lists all targets. ## Requirements ## -Sphinx and Latex is needed to build doc. +Sphinx (>= 1.3) and Latex is needed to build doc. **Sphinx:** ```sh From 500044997017b76aefc6117c9fb717abb2889e1a Mon Sep 17 00:00:00 2001 From: emmanuelle Date: Fri, 11 Dec 2015 00:44:16 +0100 Subject: [PATCH 2/2] Fixed broken sphinx link --- doc/source/user_guide/transforming_image_data.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/user_guide/transforming_image_data.txt b/doc/source/user_guide/transforming_image_data.txt index 9dfe3139..f5b92e45 100644 --- a/doc/source/user_guide/transforming_image_data.txt +++ b/doc/source/user_guide/transforming_image_data.txt @@ -122,7 +122,7 @@ the image. The histogram of pixel values is computed with :func:`histogram` returns the number of pixels for each value bin, and the centers of the bins. The behavior of :func:`histogram` is therefore -slightly different from the one of :func:`np.histogram`, which returns +slightly different from the one of :func:`numpy.histogram`, which returns the boundaries of the bins. The simplest contrast enhancement :func:`rescale_intensity` consists in