scikit-learn/doc
Jaques Grobler 5f43ada37e Added links, images and docstrings to some plot files 2012-02-24 16:51:49 +01:00
..
datasets FIX dataset docs: changed suffixes in include to match rename. 2012-02-21 00:51:52 +01:00
developers Merge pull request #602 from jaquesgrobler/doc_remotes_note 2012-02-01 08:28:13 -08:00
images Web page layout tweaks. 2011-11-21 17:33: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 DOC fixed inconsistent titles. sphinx didn't like them and didn't show these sections. 2012-02-21 00:54:53 +01:00
sphinxext MISC: make sure two figures hold on a line 2012-01-31 18:10:43 +01:00
templates Add function template for doc. 2010-10-05 14:33:24 +02:00
themes/scikit-learn latest version -> latest stable version 2012-02-09 06:31:44 -08:00
tutorial Added links, images and docstrings to some plot files 2012-02-24 16:51:49 +01: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 MISC: fix bibtex 2012-01-25 18:46:11 +01:00
conf.py turn off old version warning 2012-01-26 06:53:07 -08: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 Insert hidden toctree, mv "included" files from rst to txt 2012-02-17 22:33:53 +01:00
install.rst DOC fixed doc errors in metrics module 2012-01-28 15:32:28 +01: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 placed semi-supervised under supervised learning techniques in user 2012-02-01 18:01:21 -08:00
support.rst DOC website: added link to 0.10 docs under support. 2012-01-22 20:34:46 +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 Merge branch 'master' into svm_class_weights 2012-02-17 15:39:39 +01: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
...