Files
scikit-image/doc
Johannes Schönberger 9e4d0eebdd Merge pull request #1672 from tv3141/add_prewitt_filter_to_example
The edge filter example contains all implemented filters apart from t…
2015-09-05 10:31:02 -04:00
..
2015-03-14 10:35:04 -05:00
2015-09-04 08:03:01 -05:00
2012-10-29 18:10:39 +01:00
2015-08-28 19:00:28 +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.

Sphinx:

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)