scikit-learn/doc
Peter Prettenhofer 7840620270 added SGD L2 fix to whatsnew 2013-05-31 09:25:19 +02:00
..
datasets DOC fetch_20newsgroups returns the text, not text files. see SO question: http://stackoverflow.com/questions/16615523/using-scikits-kmeans-to-cluster-ones-own-documents 2013-05-19 16:45:39 +02:00
developers DOC Fix estimator unsupervised fit method signature 2013-05-14 13:23:18 +10:00
images deleted unnecessary thumbnail 2013-04-26 14:38:17 +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 corrected doctests after moving L2 penalty application in SGD 2013-05-29 16:38:34 +02:00
sphinxext FIX gen_rst.py was something using an undefined variable 2013-04-23 10:36:17 +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 link updated 2013-05-24 00:17:13 +02:00
tutorial maintenance scripts added for machine learning maps - needed for modifying the map in future 2013-05-14 21:28:30 +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 DOC add 2012 GSOC students 2013-04-29 18:20:21 +02:00
conf.py add optional banner to index page to advertise code sprints 2013-05-23 21:40:25 +02: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: libatlas3-base in requirement 2013-04-24 09:09:41 -06: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 REL change version to 0.14-git everywhere, update news, support page. 2013-01-21 22:07:26 +01:00
unsupervised_learning.rst TL directory change to push label propagation code into semi_supervised 2012-01-22 21:13:56 -08: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 added SGD L2 fix to whatsnew 2013-05-31 09:25:19 +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
...