diff --git a/doc/README b/doc/README new file mode 100644 index 0000000000000000000000000000000000000000..3a8c4a26464c34633d662f65e5df6d494af32838 --- /dev/null +++ b/doc/README @@ -0,0 +1,29 @@ +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 his project with a UNIX name of "fooproject": + +[jsmith@linux ~]$ scp -r _build/html/* jsmith,scikit-learn@web.sourceforge.net:htdocs +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: +barfile 100% 241 0.2KB/s 00:01 + +