scikit-learn/doc
Arnaud Joly f4eded634d DOC overall improvements
Typo

COSMIT remove debug print

DOC better docstring

Typo

Remove aborted examples

DOC fix numpy doc rendering

DOC fix the figure grid has been transposed

DOC precise which estimators

DOC polish example

DOC wording
2013-07-26 16:01:04 +02:00
..
datasets started biclustering documentation and examples 2013-07-25 19:19:17 +02:00
developers Reference to graph components updated in dev docs 2013-07-22 10:27:25 +02:00
images FIX: uneven RBM image 2013-07-24 17:27:20 +02:00
includes DOC: Less warnings during build 2011-04-10 13:59:29 +02:00
logos working version 2012-09-30 18:58:16 +02:00
modules DOC overall improvements 2013-07-26 16:01:04 +02:00
sphinxext syntax fix 2013-07-24 05:57:26 +02:00
templates DOC added a new template to sphinx so view the "__call__" function. 2013-02-03 15:49:38 +01:00
themes/scikit-learn Merge pull request #2205 from jaquesgrobler/ENH_rel_canonical 2013-07-24 06:34:04 -07:00
tutorial DOC recommend understanding NumPy in the tutorial 2013-07-25 19:08:26 +02:00
Makefile Merge branch 'master' of https://github.com/jaquesgrobler/scikit-learn into fix_doc_clean 2012-11-15 10:20:19 +01:00
README DOC ported latexpdf target from Sphinx 1.0.7-generated Makefile 2011-10-12 14:52:52 +02:00
about.rst COSMIT sphinx fixes 2013-07-23 15:02:10 +02:00
conf.py Got all the doc-tests working 2013-07-10 10:52:25 -04:00
data_transforms.rst DOC: put feature extraction before pre-processing. 2013-04-18 22:50:51 +09:00
index.rst Fix link to plot_lda_qda example. 2012-12-21 14:53:36 -07:00
install.rst DOC dependency installation with yum (Red Hat, CentOS) 2013-06-01 16:34:20 +02:00
make.bat Initial import of rst docs. 2010-01-14 15:13:39 +00:00
model_selection.rst Add some narrative doc. 2012-11-19 23:03:03 +09:00
presentations.rst DOC fix some layout on the "presentations" page, add Jake's resent PyData NYC tutorial. 2012-11-14 20:50:16 +00:00
supervised_learning.rst DOC : fix move of isotonic in doc + examples 2012-11-14 22:42:03 +01:00
support.rst DOC spellfixes 2013-06-29 16:18:23 +03:00
unsupervised_learning.rst started biclustering documentation and examples 2013-07-25 19:19:17 +02:00
user_guide.rst moved tutorial files into separete folder within main tutorial folder. added folder for section2 tutorial. fixed some links.removed savefigure from plot_cv_diabetes.py 2012-02-10 12:16:14 +01:00
whats_new.rst Update what's new 2013-07-26 12:41:27 +02:00

README

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

This section contains the full manual and web page as displayed in
http://scikit-learn.sf.net. 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


Upload the generated doc to sourceforge
---------------------------------------

First of, generate the html documentation::

    make html

This should create a directory _build/html with the documentation in html
format.


Now can upload the generated HTML documentation using scp or some other SFTP
clients.

    * Project web Hostname: web.sourceforge.net
    * Path: htdocs/
    * Username: Combine your SourceForge.net Username with your SourceForge.net
      project UNIX name using a comma ( "," ); see below
    * Password: Your SourceForge.net Password

An example session might look like the following for Username "jsmith"
uploading a file for this project, using rsync with the right switch for the
permissions:

[jsmith@linux ~]$ rsync -rltvz --delete _build/html/ \
> jsmith,scikit-learn@web.sourceforge.net:htdocs/dev -essh
Connecting to web.sourceforge.net...
The authenticity of host 'web.sourceforge.net (216.34.181.57)' can't be established.
RSA key fingerprint is 68:b3:26:02:a0:07:e4:78:d4:ec:7f:2f:6a:4d:32:c5.
Are you sure you want to continue connecting (yes/no)? yes
Warning: Permanently added 'web.sourceforge.net,216.34.181.57' (RSA) to the list of known hosts.
jsmith,fooproject@web.sourceforge.net's password:
sending incremental file list
...