scikit-learn/doc
Andreas Mueller dfa90ecf2d add booking.com testimonial 2016-04-07 14:31:38 +02:00
..
datasets [DOC] Fix broken links 2016-03-23 12:45:34 -07:00
developers [DOC] Fix broken links 2016-03-23 12:45:34 -07:00
images website: added NYU funding to front-page footer and the about section. 2015-11-24 15:20:59 -05:00
includes DOC: Less warnings during build 2011-04-10 13:59:29 +02:00
logos DOC optimize some PNG images, shaves off 24kB 2014-07-09 17:40:57 +02:00
modules [MRG] fix documentation typo 2016-04-04 10:08:42 +02:00
sphinxext FIX #5485 Replaced missing plot_gp_regression with plot_gpr_co2 in carousel. 2015-12-16 19:53:11 -08:00
templates DOC/SPHINX Add template for classes which don't have init (Exception classes) 2015-10-19 22:35:36 +02:00
testimonials add booking.com testimonial 2016-04-07 14:31:38 +02:00
themes/scikit-learn Fix misuse of it's 2016-02-26 10:16:28 +08:00
tutorial [DOC] Fix broken links 2016-03-23 12:45:34 -07:00
Makefile DOC provide PDF documentation for download 2015-09-01 19:22:50 +10:00
README [DOC] Fix broken links 2016-03-23 12:45:34 -07:00
about.rst [DOC] Fix broken links 2016-03-23 12:45:34 -07:00
conf.py Update copyright year in the doc footer (2015 → 2016) 2016-03-15 00:20:00 +03:00
data_transforms.rst minor grammatical fix 2015-11-16 14:27:51 -08:00
documentation.rst REL add 0.17.0 release to news, fix versions in menu 2015-11-19 18:00:10 -05:00
faq.rst Merge pull request #6411 from nelson-liu/create_issue_pr_template 2016-02-29 16:34:00 -05:00
index.rst typo fixes in the current changelog 2016-02-09 16:41:20 -05:00
install.rst [DOC] Fix broken links 2016-03-23 12:45:34 -07:00
make.bat Initial import of rst docs. 2010-01-14 15:13:39 +00:00
model_selection.rst DOC Add the learning curve documentation to model_selection.rst 2015-11-04 15:22:09 +01:00
preface.rst minor fixes to the doc build 2015-09-11 17:32:51 -04:00
presentations.rst [DOC] Fix broken links 2016-03-23 12:45:34 -07:00
related_projects.rst [DOC] Fix broken links 2016-03-23 12:45:34 -07:00
supervised_learning.rst (WIP) Added Multi-layer perceptron (MLP) 2015-10-21 14:41:40 -04:00
support.rst adding 0.17 support link 2015-12-09 17:04:29 +01:00
tune_toc.rst sidebar hide on css 2015-05-25 18:25:11 +02:00
unsupervised_learning.rst (WIP) Added Multi-layer perceptron (MLP) 2015-10-21 14:41:40 -04:00
user_guide.rst DOC organise documentation hierarchy / table of contents 2015-06-12 08:09:41 +10:00
whats_new.rst What's new? 2016-04-01 14:42:25 -04:00

README

Documentation for scikit-learn
-------------------------------

This section contains the full manual and web page as displayed in
http://scikit-learn.org. To generate the full web page, including
the example gallery (this might take a while):

    make html

Or, if you'd rather not build the example gallery:

    make html-noplot

That should create all the doc in directory _build/html

To build the PDF manual, run

    make latexpdf


The website is hosted at github and can be updated manually (for releases)
by pushing to the https://github.com/scikit-learn/scikit-learn.github.io repository.

It's recommended to run OptiPNG, before uploading the website.
The PNG files generated by Matplotlib tend to be ~20% too big, and they're
costing us bandwidth. You can run OptiPNG with::

    make optipng

Development documentation automated build
-----------------------------------------

A Rackspace cloud server named 'docbuilder' is continuously building the master branch
to update the http://scikit-learn.org/dev tree of the website.

The configuration of this server is managed at:

  https://github.com/scikit-learn/sklearn-docbuilder