scikit-learn/doc
Fabian Pedregosa b8d080e4ac Use relative imports inside scikits.learn.
Some fixes and specified in the docs.
2010-08-17 14:59:12 +02:00
..
images DOC: Adapt the getting started tutorial to complete beginners. 2010-04-22 19:10:17 +00:00
logos FIX: Compatibility Visual Studio 2010-04-30 13:24:15 +00:00
modules Add a reference to density estimation in GMM docs. 2010-08-17 14:55:10 +02:00
sphinxext BUG: Make sure the docs still build with recent versions of numpy 2010-07-27 09:42:50 +02:00
Makefile Remove also auto-generated examples with make clean 2010-06-26 08:12:00 -05:00
README DOC: Update docs README to use rsync and try to be careful about the 2010-04-21 08:57:29 +00:00
about.rst Documentation update. 2010-03-17 13:32:07 +00:00
conf.py Start of 0.5 development cycle. 2010-06-26 09:21:24 -05:00
contribute.rst Use relative imports inside scikits.learn. 2010-08-17 14:59:12 +02:00
index.rst MISC: Remove warning when compiling docs. 2010-07-27 09:42:51 +02:00
install.rst Update references to the svn in the docs. 2010-05-07 10:47:06 +02:00
make.bat Initial import of rst docs. 2010-01-14 15:13:39 +00:00
supervised_learning.rst DOC: fixes and enhacements for the docs. 2010-05-27 15:35:05 +02:00
tutorial.rst example usage of MLComp document classification datasets 2010-07-04 22:40:27 +02:00
unsupervised_learning.rst Update doc with new gmm module. 2010-06-22 16:19:39 +02:00

README

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 _build/html/ jsmith,scikit-learn@web.sourceforge.net:htdocs/ -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
...