b4561f09e6
|
||
|---|---|---|
| .. | ||
| datasets | ||
| developers | ||
| images | ||
| includes | ||
| logos | ||
| modules | ||
| sphinxext | ||
| templates | ||
| testimonials | ||
| themes/scikit-learn | ||
| tutorial | ||
| whats_new | ||
| Makefile | ||
| README.md | ||
| about.rst | ||
| conf.py | ||
| data_transforms.rst | ||
| documentation.rst | ||
| faq.rst | ||
| index.rst | ||
| install.rst | ||
| make.bat | ||
| model_selection.rst | ||
| preface.rst | ||
| presentations.rst | ||
| related_projects.rst | ||
| supervised_learning.rst | ||
| support.rst | ||
| tune_toc.rst | ||
| unsupervised_learning.rst | ||
| user_guide.rst | ||
| whats_new.rst | ||
README.md
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):
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
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::
make optipng
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: