Kevin Keraudren
040a53456d
- model.params holds the legacy params (2D representation), - model.new_params holds the true ND line representation. The proposed LineModel behaves identically as the implementation in master in the 2D case. In the 3D case, it behaves similarly to the previously proposed LineModel3D, as long as new_params is used instead of params. This implementation thus takes advantage that the 2D case is a special case of the ND general model.
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)
Auto-generating dev docs
This set of instructions was used to create scikit-image/tools/deploy-docs.sh
- Go to Github account settings -> personal access tokens
- Create a new token with access rights
public_repoanduser:email only - Install the travis command line tool:
gem install travis. On OSX, you can get gem viabrew install ruby. - Take then token generated by Github and run
travis encrypt GH_TOKEN=<token>from inside a scikit-image repo - Paste the output into the secure: field of
.travis.yml. - The decrypted GH_TOKEN env var will be available for travis scripts
https://help.github.com/articles/creating-an-access-token-for-command-line-use/ http://docs.travis-ci.com/user/encryption-keys/