Skip to content

Latest commit

 

History

History
62 lines (42 loc) · 1.22 KB

CONTRIBUTING.rst

File metadata and controls

62 lines (42 loc) · 1.22 KB

Contributing

Building instructions

To generate the html output for on-screen display, Type:

make html

the generated html files can be found in build/html

The first build takes a long time, but information is cached and subsequent builds will be faster.

To generate the pdf file for printing:

make pdf

The pdf builder is a bit pointy and you might have some TeX errors. Tweaking the layout in the *.rst files is usually enough to work around these problems.

Requirements

probably incomplete

  • make
  • sphinx (>= 1.0)
  • pdflatex
  • pdfjam
  • matplotlib
  • scikit-learn (>= 0.8)
  • scikit-image
  • pandas
  • seaborn

Building on Fedora

As root:

yum install python make python-matplotlib texlive-pdfjam texlive scipy \
texlive-framed texlive-threeparttable texlive-wrapfig texlive-multirow
pip install Sphinx
pip install Cython
pip install scikit-learn
pip install scikit-image

Contributing guide and example chapter

The directory guide contains an example chapter with specific instructions on how to contribute:

Example chapter

.. toctree::

 guide/index.rst