Files
scikit-image/doc
Steven Silvester 1b30c68d28 # This is a combination of 10 commits.
# The first commit's message is:
Update equalize_adapthist to use new view_as_windows

Try rbase again

Update equalize_adapthist to use new view_as_windows

Fix relative imports

# This is the 2nd commit message:

Style fixes

# This is the 3rd commit message:

Add a deprecation warning and add to api_changes.txt

# This is the 4th commit message:

Update TODO and switch to 0.13 deprecation

# This is the 5th commit message:

Preserve the current API as much as possible and defer to 0.14

# This is the 6th commit message:

Move the new kwarg to the very end

# This is the 7th commit message:

Clarify deprecation warning

# This is the 8th commit message:

Update to use row/col in clahe

# This is the 9th commit message:

Update docstring

# This is the 10th commit message:

Use optimal_step to set up view_as_windows
2015-07-14 07:47:21 -05:00
..
2015-03-14 10:35:04 -05:00
2015-05-19 17:14:28 -05:00
2012-10-29 18:10:39 +01:00
2015-03-14 20:27:03 +01:00

Building docs

To build docs, run make in this directory. make help lists all targets.

Requirements

Sphinx and Latex is needed to build doc.

Spinx:

pip install sphinx

Latex Ubuntu:

sudo apt-get install -qq texlive texlive-latex-extra dvipng

Latex Mac:

Install the full MacTex installation or install the smaller BasicTex and add ucs and dvipng packages:

sudo tlmgr install ucs dvipng

Fixing Warnings

  • "citation not found: R###" $ cd doc/build; grep -rin R### . There is probably an underscore after a reference in the first line of a docstring (e.g. [1]_)

  • "Duplicate citation R###, other instance in..."" There is probably a [2] without a [1] in one of the docstrings

  • Make sure to use pre-sphinxification paths to images (not the _images directory)