11# Documentation for scikit-learn  
22
3- This section  contains the full manual and web page  as displayed in 
3+ This directory  contains the full manual and web site  as displayed at 
44http://scikit-learn.org .
5- Building the website requires the sphinx and sphinx-gallery packages:
65
7-      pip install sphinx sphinx-gallery 
6+ ##  Building manually 
87
9- To generate the full web page, including the example gallery (this might take a
8+ Building the website requires the sphinx, sphinx-gallery and matplotlib
9+ packages:
10+ 
11+     pip install sphinx numpydoc sphinx-gallery matplotlib 
12+ 
13+ It also requires having the version of scikit-learn installed that corresponds
14+ to the documentation, e.g.:
15+ 
16+     pip install --editable .. 
17+ 
18+ To generate the full web site, including the example gallery (this might take a
1019while):
1120
1221    make html 
@@ -15,27 +24,19 @@ Or, if you'd rather not build the example gallery:
1524
1625    make html-noplot 
1726
18- That should create all the doc in directory _ build/html
27+ That should create all the doc in directory ` _build/html ` 
1928
2029To build the PDF manual, run
2130
2231    make latexpdf 
2332
24- The website is hosted at github and can be updated manually (for releases)
25- by pushing to the https://github.com/scikit-learn/scikit-learn.github.io  repository.
26- 
27- It's recommended to run OptiPNG, before uploading the website.
28- The PNG files generated by Matplotlib tend to be ~ 20% too big, and they're
29- costing us bandwidth. You can run OptiPNG with::
30- 
31-     make optipng 
32- 
33- # Development documentation automated build  
33+ Make sure you first have the correct version of scikit-learn
3434
35- A Rackspace cloud server named 'docbuilder' is continuously building the master branch
36- to update the http://scikit-learn.org/dev  tree of the website.
35+ ## Hosting and automatic builds  
3736
38- The configuration of this server is managed at:
39- 
40-   https://github.com/scikit-learn/sklearn-docbuilder 
37+ The website is hosted at github, but should rarely be updated manually
38+ by pushing to the https://github.com/scikit-learn/scikit-learn.github.io  repository.
4139
40+ Most updates can be made by pushing to master (for /dev) or a release branch
41+ like 0.99.X, from which Circle CI builds and uploads documentation. (See the
42+ Developer Documentation for further details.)
0 commit comments