scikit-learn/doc
SmedbergM 765f77e2c4 Read web pages as UTF-8 by default. Use with-blocks to open files. 2016-02-16 16:14:42 +01:00
..
datasets General spelling fixes 2015-12-16 09:46:42 -08:00
developers Merge pull request #5425 from amueller/update_doc_readme 2016-02-11 22:28:11 +11: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 DOC: very minor typo 2016-02-15 23:14:45 -05: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 link to ETL. 2015-10-13 00:26:20 +09:00
themes/scikit-learn Updated examples and tests that use scipy's lena 2016-02-11 09:13:40 +01:00
tutorial Read web pages as UTF-8 by default. Use with-blocks to open files. 2016-02-16 16:14:42 +01:00
Makefile DOC provide PDF documentation for download 2015-09-01 19:22:50 +10:00
README The docs have moved 2015-10-26 08:41:10 +01:00
about.rst website: added NYU funding to front-page footer and the about section. 2015-11-24 15:20:59 -05:00
conf.py Update copyright year in the doc footer (2014 → 2015) 2015-11-05 00:20:45 +01: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 Rewordin algorithm requirements in FAQ 2016-01-30 01:16:29 +05:30
index.rst typo fixes in the current changelog 2016-02-09 16:41:20 -05:00
install.rst split installation into simple and advanced part 2015-11-04 14:28:25 -05: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 add scipy2013 tutorial links to presentations on website. 2015-03-05 11:44:07 -05:00
related_projects.rst Merge pull request #5999 from jseabold/doc-fix 2015-12-10 16:44:50 -05: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 inverse_transformation for NMF decomposition 2016-02-11 23:30:10 +05:30

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:

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