Documentation for scikit-learn
This section contains the full manual and web page as displayed in http://scikit-learn.org. Building the website requires the sphinx and sphinx-gallery packages:
pip install sphinx sphinx-gallery
To generate the full web page, including the example gallery (this might take a while):
Or, if you'd rather not build the example gallery:
That should create all the doc in directory _build/html
To build the PDF manual, run
The website is hosted at github and can be updated manually (for releases) by pushing to the https://github.com/scikit-learn/scikit-learn.github.io repository.
It's recommended to run OptiPNG, before uploading the website. The PNG files generated by Matplotlib tend to be ~20% too big, and they're costing us bandwidth. You can run OptiPNG with::
Development documentation automated build
A Rackspace cloud server named 'docbuilder' is continuously building the master branch to update the http://scikit-learn.org/dev tree of the website.
The configuration of this server is managed at: