scikit-learn/doc
GaelVaroquaux df1e71149c DOC: ward docstring and testing 2012-07-26 09:15:57 +02:00
..
datasets rm the long-deprecated scikits.learn package 2012-07-23 13:56:13 +02:00
developers DOC: cosmit performance instructions 2012-07-23 19:18:31 +02:00
images COSMIT minor visual enhancement 2012-03-18 17:39:29 +01:00
includes DOC: Less warnings during build 2011-04-10 13:59:29 +02:00
logos Description for logo: font, color, etc. 2011-11-16 09:43:10 +01:00
modules FIXed another doctest. 2012-07-25 22:04:57 +01:00
sphinxext COSMIT don't call magic methods directly 2012-07-21 17:38:15 +02:00
templates Add function template for doc. 2010-10-05 14:33:24 +02:00
themes/scikit-learn added alternating columns for tables in documentation and a tighter layout in pre 2012-07-12 11:51:07 +02:00
tutorial DOC: ward docstring and testing 2012-07-26 09:15:57 +02:00
Makefile rm the long-deprecated scikits.learn package 2012-07-23 13:56:13 +02:00
README DOC ported latexpdf target from Sphinx 1.0.7-generated Makefile 2011-10-12 14:52:52 +02:00
about.rst MISC: fix bibtex 2012-01-25 18:46:11 +01:00
conf.py DOC user guide pdf building. Kicked out a formular that rendered neither in html nor latex. Please don't hit me. 2012-06-04 23:40:17 +02:00
data_transforms.rst ENH: Restructuring User Guide: kernel_approximation, preprocessing and feature_extraction are under a common chapter, " 2011-12-20 14:17:50 +01:00
index.rst DOC typos 2012-07-21 01:38:25 +02:00
install.rst COSMIT, removed scikits.learn things, removed orphan file. 2012-07-23 22:50:12 +01:00
make.bat Initial import of rst docs. 2010-01-14 15:13:39 +00:00
model_selection.rst DOC Added pipeline user guide 2012-05-06 17:56:30 +02:00
presentations.rst DOC minor fixes to rst and image paths 2012-05-06 23:28:31 +02:00
supervised_learning.rst FIX minor doc fixes 2012-03-04 20:13:22 +01:00
support.rst Fixed broken links on Support page 2012-07-23 11:58:56 +02: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 rm the long-deprecated scikits.learn package 2012-07-23 13:56:13 +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
...