87759c1924
|
||
|---|---|---|
| .. | ||
| datasets | ||
| developers | ||
| images | ||
| includes | ||
| logos | ||
| modules | ||
| sphinxext | ||
| templates | ||
| testimonials | ||
| themes/scikit-learn | ||
| tutorial | ||
| whats_new | ||
| Makefile | ||
| README.md | ||
| about.rst | ||
| conf.py | ||
| conftest.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 directory contains the full manual and web site as displayed at http://scikit-learn.org.
Building manually
Building the website requires the sphinx, sphinx-gallery and matplotlib packages:
pip install sphinx numpydoc sphinx-gallery matplotlib
It also requires having the version of scikit-learn installed that corresponds to the documentation, e.g.:
pip install --editable ..
To generate the full web site, 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
Make sure you first have the correct version of scikit-learn
Hosting and automatic builds
The website is hosted at github, but should rarely be updated manually by pushing to the https://github.com/scikit-learn/scikit-learn.github.io repository.
Most updates can be made by pushing to master (for /dev) or a release branch like 0.99.X, from which Circle CI builds and uploads documentation. (See the Developer Documentation for further details.)