DOC improve documentation (#10)

rth · web-flow · commit 36a0ec1ebc56 · 2019-04-24T09:04:52.000+02:00
diff --git a/README.rst b/README.rst
@@ -29,9 +29,9 @@ Dependencies
 
 scikit-learn-extra requires,
  
- - Python (>=3.5)
- - scikit-learn (>=0.20), and its dependencies
- - Cython (>0.28)
+- Python (>=3.5)
+- scikit-learn (>=0.20), and its dependencies
+- Cython (>0.28)
 
 
 User installation
diff --git a/doc/index.rst b/doc/index.rst
@@ -6,32 +6,18 @@
 scikit-learn-extra documentation
 ================================
 
+scikit-learn-extra is a Python module for machine learning that extends scikit-learn. It includes algorithms that are useful but do not satisfy the scikit-learn `inclusion criteria <https://scikit-learn.org/stable/faq.html#what-are-the-inclusion-criteria-for-new-algorithms>`_, for instance due to their novelty or lower citation number.
 
 .. toctree::
    :maxdepth: 2
-   :hidden:
    :caption: Documentation
 
+   install
    user_guide
    api
 
 .. toctree::
    :maxdepth: 2
-   :hidden:
    :caption: Examples
 
    auto_examples/index
-
-`User Guide <user_guide.html>`_
--------------------------------
-
-The user guide (to be added)
-
-`API Documentation <api.html>`_
--------------------------------
-
-
-`Examples <auto_examples/index.html>`_
---------------------------------------
-
-A set of examples. It complements the `User Guide <user_guide.html>`_.
diff --git a/doc/install.rst b/doc/install.rst
@@ -0,0 +1,21 @@
+Installation
+------------
+
+Dependencies
+^^^^^^^^^^^^
+
+scikit-learn-extra requires,
+ 
+- Python (>=3.5)
+- scikit-learn (>=0.20), and its dependencies
+- Cython (>0.28)
+
+
+User installation
+^^^^^^^^^^^^^^^^^
+
+Latest development version can be installed with,
+
+.. code::
+
+    pip install https://github.com/scikit-learn-contrib/scikit-learn-extra/archive/master.zip
diff --git a/doc/quick_start.rst b/doc/quick_start.rst
diff --git a/doc/requirements-doc.txt b/doc/requirements-doc.txt
@@ -0,0 +1,6 @@
+sphinx
+scikit-learn>=0.20
+cython
+pillow
+sphinx_rtd_theme
+numpydoc
diff --git a/sklearn_extra/kernel_approximation/_fastfood.py b/sklearn_extra/kernel_approximation/_fastfood.py
@@ -47,7 +47,7 @@ class Fastfood(BaseEstimator, TransformerMixin):
     Quoc Le, Tamas Sarl and Alex Smola.
 
     Examples
-    ----
+    --------
     See scikit-learn-fastfood/examples/plot_digits_classification_fastfood.py
     for an example how to use fastfood with a primal classifier in comparison
     to an usual rbf-kernel with a dual classifier.
