Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

This branch is 11230 commits behind scikit-learn:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

..
Failed to load latest commit information.
datasets
developers
images
includes
logos
modules
sphinxext
templates
themes/scikit-learn
Makefile
README
about.rst
conf.py
data_transforms.rst
index.rst
install.rst
make.bat
model_selection.rst
supervised_learning.rst
support.rst
tutorial.rst
unsupervised_learning.rst
user_guide.rst
whats_new.rst

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
...
Something went wrong with that request. Please try again.