baohan
/
scikit-learn
mirror of https://github.com/scikit-learn/scikit-learn.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
scikit-learn/doc
History
Gael varoquaux 796dcbce5c DOC: load_filenames -> load_files 2011-07-30 18:05:47 +02:00
..
datasets DOC: load_filenames -> load_files 2011-07-30 18:05:47 +02:00
developers DOC: Improve the Bayesian regression docs 2011-07-23 14:17:06 +02:00
images DOC: make the face recognition example static (to avoid having to download the dataset to build the doc) 2011-04-11 13:55:52 +02:00
includes DOC: Less warnings during build 2011-04-10 13:59:29 +02:00
logos Add png logo. 2010-10-06 12:09:06 +02:00
modules API : renaming LARS to Lars 2011-07-25 21:41:48 -04:00
sphinxext More mutable default args 2011-07-23 21:17:18 +02:00
templates Add function template for doc. 2010-10-05 14:33:24 +02:00
themes/scikit-learn Layout tweaks. 2011-07-07 15:57:04 +02:00
Makefile BUG: giving up on cleaning build 2011-04-03 14:56:16 +02:00
README Update rsync command 2011-07-18 10:40:31 +02:00
about.rst typo 2011-05-04 15:12:13 +02:00
conf.py 2010 is so last year 2011-05-30 10:49:05 +02:00
contents.rst FIX: make the dataset doctest fixture modular 2011-06-15 00:55:35 +02:00
index.rst Layout tweaks. 2011-07-07 15:57:04 +02:00
install.rst Changelog 2011-05-10 14:17:15 +02:00
make.bat Initial import of rst docs. 2010-01-14 15:13:39 +00:00
model_selection.rst DOC: Less warnings during build 2011-04-10 13:59:29 +02:00
supervised_learning.rst DOC: Less warnings during build 2011-04-10 13:59:29 +02:00
support.rst FIX the IRC chan used is scikit-learn, and not learn 2011-07-15 19:00:20 +02:00
tutorial.rst FIX: reflect SVC API change (eps -> tol) in doc/tutorial.rst 2011-05-11 12:21:16 -04:00
unsupervised_learning.rst Some documentation for hmm module, and a warning. 2011-07-12 11:31:57 +02:00
user_guide.rst DOC: Fix more warnings 2011-04-10 17:27:53 +02:00
whats_new.rst API : renaming LARS to Lars 2011-07-25 21:41:48 -04:00

README 

Documentation for scikits.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, you should first make the latex docs:

    make latex

and then:

   cd _build/latex
   make all-pdf


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 fornmat.


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 Example
    * 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
...