scikit-learn/doc
dengemann a9250af672 ENH/FIX: misc + address discussion 2013-09-04 22:04:40 +02:00
..
datasets DOC add link to fetch_covertype to covertype narrative docs 2013-08-04 17:12:55 +02:00
developers FIX: test doc np.allclose 2013-08-25 15:38:21 +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 Add .bmp sklearn logo of correct width for Win setup 2013-08-20 15:41:38 +03:00
modules DOC broken link in HMM narrative 2013-09-03 14:57:02 +02:00
sphinxext BUG fix whitespace in error messages 2013-08-26 17:02:52 +02:00
templates DOC added a new template to sphinx so view the "__call__" function. 2013-02-03 15:49:38 +01:00
testimonials WEBSITE add yhat testimonial 2013-08-21 13:35:47 +02:00
themes/scikit-learn DOC: link to documentation, not main page 2013-08-08 01:31:37 +02:00
tutorial commit added for hack-warning 2013-08-02 13:25:10 +02:00
Makefile DOC now building to html/stable 2013-07-30 09:40:07 +02:00
README DOC now building to html/stable 2013-07-30 09:40:07 +02:00
about.rst COSMIT sphinx fixes 2013-07-23 15:02:10 +02:00
conf.py MAINT/DOC: bump docs and rev numbers to 0.15-git 2013-08-08 01:13:06 +02:00
data_transforms.rst DOC: put feature extraction before pre-processing. 2013-04-18 22:50:51 +09:00
documentation.rst MAINT/DOC: bump docs and rev numbers to 0.15-git 2013-08-08 01:13:06 +02:00
index.rst WEBSITE add yhat testimonial 2013-08-21 13:35:47 +02: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 minor typo thing 2013-07-28 11:15:03 +02:00
supervised_learning.rst DOC reference and rename cross decomposition module 2013-07-28 02:56:12 +02:00
support.rst DOC spellfixes 2013-06-29 16:18:23 +03:00
unsupervised_learning.rst DOC fixing some sphinx stuff. 2013-07-27 18:16:46 +02:00
user_guide.rst fix sidebar button size staying constant and leaving a mountain of white-space due to expanding/collapsing toctree 2013-07-31 11:22:59 +02:00
whats_new.rst ENH/FIX: misc + address discussion 2013-09-04 22:04:40 +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/stable 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/stable/ \
> 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
...