mirror of
https://github.com/wassname/scikit-image.git
synced 2026-06-28 13:37:50 +08:00
Robin Wilson
27730d11ab
This is usually created automatically by sphinx-quickstart, but seems to be missing in skimage. It caused a number of problems for Windows users during the EuroSciPy 2015 sprints.
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)