baohan
/
scikit-learn
mirror of https://github.com/scikit-learn/scikit-learn.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
scikit-learn/doc
History
Lars Buitinck 627bf4144d DOC typos and style in linear_model docs 2011-11-03 19:54:47 +01:00
..
datasets Add mldata loader and olivetti dataset to changelog. 2011-09-21 23:32:57 +02:00
developers FIX replace np.atleast_2d with new utils.array2d 2011-10-25 15:16:31 +02:00
images modified threshold comparison from < to <= 2011-10-04 13:32:07 +01:00
includes DOC: Less warnings during build 2011-04-10 13:59:29 +02:00
logos Generate thumbnails in the example gallery 2011-09-01 09:35:29 +02:00
modules DOC typos and style in linear_model docs 2011-11-03 19:54:47 +01:00
sphinxext layout tweaks 2011-09-02 10:29:10 +02:00
templates Add function template for doc. 2010-10-05 14:33:24 +02:00
themes/scikit-learn DOC correct Google URL 2011-10-22 03:43:22 +02:00
Makefile DOC ported latexpdf target from Sphinx 1.0.7-generated Makefile 2011-10-12 14:52:52 +02:00
README DOC ported latexpdf target from Sphinx 1.0.7-generated Makefile 2011-10-12 14:52:52 +02:00
about.rst Add Vlad as GSOCer 2011-09-16 09:11:40 +02:00
conf.py Start of 0.10 development cycle. 2011-09-20 16:13:30 +02:00
contents.rst Moved "feature selection" section back into the "supervised learning" chapter 2011-09-04 17:52:49 +02:00
index.rst Move matrix factorization to work in progress. 2011-09-14 12:56:58 +02:00
install.rst DOC: Install.rst wrong packaging info 2011-09-24 01:07:17 +02:00
make.bat Initial import of rst docs. 2010-01-14 15:13:39 +00:00
model_selection.rst DOC: improvements to the cross validation doc layout + missing ref to ShuffleSplit and cross_val_score 2011-09-04 19:55:44 +02:00
supervised_learning.rst DOC: minor doc ENH for trees 2011-09-25 17:51:07 +02:00
support.rst FIX the IRC chan used is scikit-learn, and not learn 2011-07-15 19:00:20 +02:00
tutorial.rst FIX #401: update tutorial doctests to reflect recent changes and add them to 2011-10-22 17:39:19 +02:00
unsupervised_learning.rst Some documentation for hmm module, and a warning. 2011-07-12 11:31:57 +02:00
user_guide.rst DOC: Fix more warnings 2011-04-10 17:27:53 +02:00
whats_new.rst DOC : adding permutation_test_score to changelog 2011-10-21 21:03:42 -04: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
...