scikit-learn/doc
Andreas Mueller 4a78deaa28 FIX: fixed link to Virgile in whats_new 2011-12-21 07:29:18 +01:00
..
datasets FIX This should fix the doctests in the datasets dir. They take quite long, I think it's because of the svmlight loaders. So I didn't include them in the standard make target 2011-12-18 19:35:22 +01:00
developers FIX minor typo 2011-12-20 13:22:40 +01: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 Merge pull request #493 from amueller/kernel_approximation_doc 2011-12-20 08:09:19 -08:00
sphinxext pep8 compliant 2011-12-17 00:48:40 +05:30
templates Add function template for doc. 2010-10-05 14:33:24 +02:00
themes/scikit-learn DOC: restore 'This page' in sidebar 2011-12-04 12:41:06 +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 FIX - error in the bibtex entry - extra comma that makes bibtex fail 2011-12-15 10:02:37 +01:00
conf.py pep8 compliant 2011-12-17 00:48:40 +05:30
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: Fixed broken reference to user guide 2011-12-18 19:28:43 +01:00
install.rst DOC: enhancement for Debian installation + fixed various typos 2011-11-30 23:05:44 -05: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: Added ensemble methods to TOC 2011-11-18 14:19:55 +01:00
support.rst DOC: Cosmits on the Support page 2011-12-20 11:21:15 +01:00
tutorial.rst s/C_scale_n_samples/scale_C 2011-11-11 21:36:19 -05:00
unsupervised_learning.rst Add tools to perform outlier detection with sklearn + documentation. 2011-12-20 13:11:43 +01:00
user_guide.rst ENH: Restructuring User Guide: kernel_approximation, preprocessing and feature_extraction are under a common chapter, " 2011-12-20 14:17:50 +01:00
whats_new.rst FIX: fixed link to Virgile in whats_new 2011-12-21 07:29:18 +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
...