wassname/scikit-image
1
0
Fork 0
mirror of https://github.com/wassname/scikit-image.git synced 2026-08-15 12:54:54 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update the README with some warning hints

Browse Source 
Update the readme with some warning hints

Tweak README

Tweak README

Fix preferred plugins test

Pep8 fix

Remove imshow from PIL plugin

Fix spelling

Tweak readme
This commit is contained in:
Steven Silvester
2015-02-07 16:40:54 -06:00
parent 5ccdd36bc3
commit fa226ad807
3 changed files with 19 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/README.md
+13
View File
@@ -3,3 +3,16 @@ To build docs, run `make` in this directory. `make help` lists all targets.
## Requirements ##
Sphinx is needed to build doc. Install with `pip install sphinx`.
## Fixing Warnings ##
- "citation not found: R###"
$ cd doc/build; grep -rin R### .
There is probably an underscore after the reference (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)