mirror of
https://github.com/wassname/scikit-image.git
synced 2026-07-03 06:53:51 +08:00
Steven Silvester
20 lines
573 B
Markdown
20 lines
573 B
Markdown
# Building docs #
|
|
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 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)
|